BSD Ports

textproc/py-mkdocstrings-python-legacy 0.2.6 DragonFly

Legacy Python handler for mkdocstrings

System
DragonFly
Repository
DPorts
Maintainer
[email protected] (as in FreeBSD)
License
ISCL
Categories
python, textproc
Package size
26.5 KiB, 122.2 KiB installed

Description

This Python handler for the "mkdocstrings" package uses PyTkDocs (= textproc/py-pytkdocs) to collect documentation from Python source code.

Features:

* Data collection from source code: collection of the object-tree and the docstrings is done thanks to pytkdocs.

* Support for type annotations: pytkdocs collects your type annotations and mkdocstrings uses them to display parameters types or return types.

* Recursive documentation of Python objects: just use the module dotted-path as identifier, and you get the full module docs. You don't need to inject documentation for each class, function, etc.

* Support for documented attributes: attributes (variables) followed by a docstring (triple-quoted string) will be recognized by Griffe in modules, classes and even in __init__ methods.

* Multiple docstring-styles support: common support for Google-style, Numpydoc-style, and Sphinx-style docstrings.

In the other systems

SystemPortVersion
DragonFlytextproc/py-mkdocstrings-python-legacy0.2.6
FreeBSDtextproc/py-mkdocstrings-python-legacy0.2.7
MidnightBSDtextproc/py-mkdocstrings-python-legacy0.2.4_1

Install

Binary package:

pkg install py311-mkdocstrings-python-legacy

From DPorts:

cd /usr/dports/textproc/py-mkdocstrings-python-legacy && make install clean

Dependencies

Run dependencies 3

No port depends on this one.