BSD Ports

textproc/py-mkdocstrings-python 2.0.1_1 MidnightBSD

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 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.

In the other systems

SystemPortVersion
MidnightBSDtextproc/py-mkdocstrings-python2.0.1_1
FreeBSDtextproc/py-mkdocstrings-python2.0.8_1
DragonFlytextproc/py-mkdocstrings-python1.16.10

Install

Binary package:

mport install ${PYTHON_PKGNAMEPREFIX}mkdocstrings-python

From mports:

cd /usr/mports/textproc/py-mkdocstrings-python && make install clean

To depend on this port in another port's Makefile:

RUN_DEPENDS=	${PYTHON_PKGNAMEPREFIX}mkdocstrings-python>0:textproc/py-mkdocstrings-python

Dependencies

As this port's Makefile names them.

Build 1

Runtime 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-legacy

Files

distinfo 1
FileSizeSHA256
mkdocstrings_python-2.0.1.tar.gz199345843a562221e6a471fefdd4b45cc6c22d2607ccbad632879234fa9692e9cf7732
Master sites 1
  • PYPI