BSD Ports

textproc/py-mkdocstrings-python 2.0.8_1 FreeBSD

Python handler for mkdocstrings

System
FreeBSD
Repository
FreeBSD ports
Maintainer
[email protected]
Last update
Commit
45ea4cf85c
License
ISCL
Categories
textproc, python
Package size
80.9 KiB, 466.1 KiB installed

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
FreeBSDtextproc/py-mkdocstrings-python2.0.8_1
DragonFlytextproc/py-mkdocstrings-python1.16.10
MidnightBSDtextproc/py-mkdocstrings-python2.0.1_1

Install

Binary package:

pkg install py312-mkdocstrings-python

From the ports tree:

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

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

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

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:latest2.0.8_12.0.8_1-1.16.122.0.8_1
FreeBSD:14:quarterly2.0.8_12.0.8_1n/a1.16.122.0.8_1
FreeBSD:15:latest2.0.8_12.0.8_1n/a1.16.121.16.12
FreeBSD:15:quarterly2.0.8_12.0.8_1n/an/an/a
FreeBSD:16:latest2.0.8_12.0.8_1n/an/an/a
FreeBSD:16:quarterlyn/an/an/an/an/a

Dependencies

As this port's Makefile names them.

Build 1

Runtime 2

Test 5

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

Build dependencies 15
Run dependencies 32
Required by 1

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

Commit history 3

DateCommitCreditsLog message
45ea4cf85c Michael Osipov */*: Bump consumers of www/beautifulsoup4 after port rename
PR: 297837 Approved by: wen (maintainer via email)
87d83c1564 Kai Knoblich textproc/py-mkdocstrings-python: Update to 2.0.8
Changelog: https://github.com/mkdocstrings/python/releases/tag/2.0.8 MFH: 2026Q3
43ef0934a3 Kai Knoblich textproc/py-mkdocstrings-python: Update to 2.0.7
Changelog since 2.0.5: https://github.com/mkdocstrings/python/blob/2.0.7/CHANGELOG.md