FreeBSD Ports

textproc/py-mkdocstrings-python-legacy 0.2.7

Legacy Python handler for mkdocstrings

Repository
FreeBSD ports
Maintainer
[email protected]
License
ISCL
Categories
textproc, python
Package size
29.1 KiB, 114.9 KiB installed

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.

Install

As a binary package — by origin, or by package name:

pkg install textproc/py-mkdocstrings-python-legacy
pkg install py312-mkdocstrings-python-legacy

From the ports tree:

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

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

RUN_DEPENDS=	py312-mkdocstrings-python-legacy>0:textproc/py-mkdocstrings-python-legacy

Packages

The version each package repository carries. “-” means the repository builds no package of it, “n/a” that there is no such repository.

Repositoryaarch64amd64armv6armv7i386
FreeBSD:14:latest0.2.70.2.7-0.2.70.2.7
FreeBSD:14:quarterly0.2.70.2.7n/a0.2.70.2.7
FreeBSD:15:latest0.2.70.2.7n/a0.2.70.2.7
FreeBSD:15:quarterly0.2.70.2.7n/an/an/a
FreeBSD:16:latest0.2.70.2.7n/an/an/a
FreeBSD:16:quarterlyn/an/an/an/an/a

Dependencies

As this port's Makefile names them.

Build 1

Runtime 2

Test 2

The full lists below include those, and their dependencies in turn.

All build dependencies 15
All run dependencies 32

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.7.tar.gz996051aa8a277a332fb0d49be3786de3fa18af7d8792e8d611f6ba8d550dc3a1ff8a1
Master sites 1
  • PYPI

Commit history 0

No commits in the history this site was built from.