BSD Ports

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

SystemPortVersion
MidnightBSDtextproc/py-mkdocstrings-python-legacy0.2.4_1
FreeBSDtextproc/py-mkdocstrings-python-legacy0.2.7
DragonFlytextproc/py-mkdocstrings-python-legacy0.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

Runtime 2

Test 2

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
FileSizeSHA256
mkdocstrings_python_legacy-0.2.4.tar.gz9721336d160ac7af5a3cec764eeb66522f42a116088a41289e04372592b91e14abbbc
Master sites 1
  • PYPI