diff options
Diffstat (limited to 'textproc/py-mkdocstrings-python-legacy/pkg-descr')
| -rw-r--r-- | textproc/py-mkdocstrings-python-legacy/pkg-descr | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/textproc/py-mkdocstrings-python-legacy/pkg-descr b/textproc/py-mkdocstrings-python-legacy/pkg-descr new file mode 100644 index 000000000000..f02e2f73ebd8 --- /dev/null +++ b/textproc/py-mkdocstrings-python-legacy/pkg-descr @@ -0,0 +1,21 @@ +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. |