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.
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 py311-mkdocstrings-python-legacy listed in the above command, you can pick from the names under the Packages section.
textproc/py-mkdocstrings-python-legacy: Update to 0.2.7
* Adjust USES=python accordingly, because Python 3.8 is no longer
present in the ports tree after ca15850a2b13 while I'm here.
Changelog:
https://github.com/mkdocstrings/python-legacy/releases/tag/0.2.7
textproc/py-mkdocstrings-python-legacy: Update to 0.2.6
* Switch back to PyPI because since this release the sdist tarball
contain all the required Python source files again and remove the
no longer required workaround for "pyproject.toml".
Changelog:
https://github.com/mkdocstrings/python-legacy/releases/tag/0.2.6
textproc/py-mkdocstrings-python-legacy: Update to 0.2.5
* Switch to GitHub for while as the sdist tarball at PyPI doesn't
contain all required Python source files.
* Support for Python 3.8 was dropped with this release, thus remove
a now obsolete hint regarding the Python version.
Changelog:
https://github.com/mkdocstrings/python-legacy/releases/tag/0.2.5
textproc/py-mkdocstrings-{crystal,python-legacy}: Adjust USE_PYTHON
* Since c0c720d7ebf0 the dependency textproc/py-mkdocs-autorefs requires
at least Python version 3.10 or newer and packages of this port for
older Python versions can no longer be build, thus set USE_PYTHON
accordingly.
textproc/py-mkdocstrings-python-legacy: Update to 0.2.4
* Remove no longer required workaround for "pyproject.toml".
* Enable all tests from the test suite, which are now packaged in the
recent sdists.
Changelog:
https://github.com/mkdocstrings/python-legacy/releases/tag/0.2.4
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.
