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.
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above. NOTE: This is a Python port. Instead of py312-mkdocstrings-python listed in the above command, you can pick from the names under the Packages section.
textproc/py-mkdocstrings-python: Update to 1.16.10
* Adjust USE=python accordingly, because Python 3.8 is no longer
present in the ports tree after ca15850a2b13 while I'm here.
Changelog since 1.6.8:
https://github.com/mkdocstrings/python/blob/1.16.10/CHANGELOG.md
MFH: 2025Q2
textproc/py-mkdocstrings-python: Update to 1.10.5
* Switch to GitHub to continue using the test suite, which is currently
not included with the recent sdist tarballs. This now makes it
possible to run all tests, some of which were not included in the
sdist.
Changelog since 1.10.3:
https://github.com/mkdocstrings/python/blob/1.10.5/CHANGELOG.md
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.
