diff options
author | Kai Knoblich <kai@FreeBSD.org> | 2023-08-31 07:25:26 +0200 |
---|---|---|
committer | Kai Knoblich <kai@FreeBSD.org> | 2023-08-31 07:44:11 +0200 |
commit | e1c6e80783e10e0716b5cab7b1b0448d5f48f7ca (patch) | |
tree | 56fde5332dd962866d67b02e3f51107d204e3b9e /textproc/py-mkdocstrings/files/patch-setup.py | |
parent | textproc/py-mkdocstrings-python: New port (diff) |
textproc/py-mkdocstrings-python-legacy: New port
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.
Diffstat (limited to 'textproc/py-mkdocstrings/files/patch-setup.py')
0 files changed, 0 insertions, 0 deletions