textproc/py-mkdocstrings-python-legacy 0.2.4_1 MidnightBSD
Legacy Python handler for mkdocstrings
- System
- MidnightBSD
- Repository
- mports
- Maintainer
- [email protected]
- License
- iscl
- Categories
- textproc, python
Description
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.
In the other systems
| System | Port | Version |
|---|---|---|
| MidnightBSD | textproc/py-mkdocstrings-python-legacy | 0.2.4_1 |
| FreeBSD | textproc/py-mkdocstrings-python-legacy | 0.2.7 |
| DragonFly | textproc/py-mkdocstrings-python-legacy | 0.2.6 |
Install
Binary package:
mport install ${PYTHON_PKGNAMEPREFIX}mkdocstrings-python-legacy
From mports:
cd /usr/mports/textproc/py-mkdocstrings-python-legacy && make install clean
To depend on this port in another port's Makefile:
RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}mkdocstrings-python-legacy>0:textproc/py-mkdocstrings-python-legacy
Dependencies
As this port's Makefile names them.
Build 1
${PYTHON_PKGNAMEPREFIX}pdm-backend>0: devel/py-pdm-backend
Runtime 2
${PYTHON_PKGNAMEPREFIX}mkdocs-autorefs>=1.1: textproc/py-mkdocs-autorefs${PYTHON_PKGNAMEPREFIX}pytkdocs>=0.14: textproc/py-pytkdocs
Test 2
${PYTHON_PKGNAMEPREFIX}mkdocs-material>0: textproc/py-mkdocs-material${PYTHON_PKGNAMEPREFIX}mkdocstrings>0: textproc/py-mkdocstrings
Build dependencies 1
Run dependencies 2
No port depends on this one.
Configuration
No options to configure.
- USES
- python
- Service scripts
- none
- Conflicts with
- ${PYTHON_PKGNAMEPREFIX}mkdocstrings-python
Files
distinfo 1
| File | Size | SHA256 |
|---|---|---|
| mkdocstrings_python_legacy-0.2.4.tar.gz | 97213 | 36d160ac7af5a3cec764eeb66522f42a116088a41289e04372592b91e14abbbc |
Master sites 1
- PYPI