diff options
author | Kai Knoblich <kai@FreeBSD.org> | 2023-08-31 07:22:23 +0200 |
---|---|---|
committer | Kai Knoblich <kai@FreeBSD.org> | 2023-08-31 07:43:40 +0200 |
commit | 656e2aeca87724087da0235269e9d7ae1e6118e8 (patch) | |
tree | f38022f94a886fc42360950044c3821341450f69 /textproc/py-mkdocstrings/files/patch-setup.py | |
parent | textproc/py-mkdocstrings-crystal: New port (diff) |
textproc/py-mkdocstrings-python: New port
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.
Diffstat (limited to 'textproc/py-mkdocstrings/files/patch-setup.py')
0 files changed, 0 insertions, 0 deletions