textproc/py-mkdocstrings-python 1.16.10 DragonFly
Python handler for mkdocstrings
- System
- DragonFly
- Repository
- DPorts
- Maintainer
- [email protected] (as in FreeBSD)
- License
- ISCL
- Categories
- python, textproc
- Package size
- 75.4 KiB, 461.8 KiB installed
Description
This Python handler for the "mkdocstrings" package uses Griffe (= textproc/py-griffe) 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 Griffe.
* Support for type annotations: Griffe collects your type annotations and mkdocstrings uses them to display parameter types or return types.
* Recursive documentation of Python objects: just use the module dotted-path as an 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. See Griffe's documentation on docstrings support.
In the other systems
| System | Port | Version |
|---|---|---|
| DragonFly | textproc/py-mkdocstrings-python | 1.16.10 |
| FreeBSD | textproc/py-mkdocstrings-python | 2.0.8_1 |
| MidnightBSD | textproc/py-mkdocstrings-python | 2.0.1_1 |
| HardenedBSD | textproc/py-mkdocstrings-python | 2.0.8_1 |
| GhostBSD | textproc/py-mkdocstrings-python | 2.0.8_1 |
Install
Binary package:
pkg install py311-mkdocstrings-python
From DPorts:
cd /usr/dports/textproc/py-mkdocstrings-python && make install clean