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
| System | Port | Version |
|---|---|---|
| FreeBSD | textproc/py-mkdocstrings-python | 2.0.8_1 |
| DragonFly | textproc/py-mkdocstrings-python | 1.16.10 |
| MidnightBSD | textproc/py-mkdocstrings-python | 2.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.
| Repository | aarch64 | amd64 | armv6 | armv7 | i386 |
|---|---|---|---|---|---|
| FreeBSD:14:latest | 2.0.8_1 | 2.0.8_1 | - | 1.16.12 | 2.0.8_1 |
| FreeBSD:14:quarterly | 2.0.8_1 | 2.0.8_1 | n/a | 1.16.12 | 2.0.8_1 |
| FreeBSD:15:latest | 2.0.8_1 | 2.0.8_1 | n/a | 1.16.12 | 1.16.12 |
| FreeBSD:15:quarterly | 2.0.8_1 | 2.0.8_1 | n/a | n/a | n/a |
| FreeBSD:16:latest | 2.0.8_1 | 2.0.8_1 | n/a | n/a | n/a |
| FreeBSD:16:quarterly | n/a | n/a | n/a | n/a | n/a |
Dependencies
As this port's Makefile names them.
Build 1
${PYTHON_PKGNAMEPREFIX}pdm-backend>0: devel/py-pdm-backend
Runtime 2
${PYTHON_PKGNAMEPREFIX}griffelib>=2.0: textproc/py-griffelib${PYTHON_PKGNAMEPREFIX}mkdocs-autorefs>=1.4: textproc/py-mkdocs-autorefs
Test 5
${PYTHON_PKGNAMEPREFIX}beautifulsoup4>=4.12.3: www/py-beautifulsoup4${PYTHON_PKGNAMEPREFIX}inline-snapshot>=0.18.1: devel/py-inline-snapshot${PYTHON_PKGNAMEPREFIX}mkdocs-material>=9.5: textproc/py-mkdocs-material${PYTHON_PKGNAMEPREFIX}mkdocstrings>=0.30.0: textproc/py-mkdocstrings${PYTHON_PKGNAMEPREFIX}ruff>=0.4: devel/py-ruff
The full lists below include those, and their dependencies in turn.
Build dependencies 15
Run dependencies 32
- archivers/liblz4
- archivers/zstd
- devel/gettext-runtime
- devel/libffi
- devel/libinotify
- devel/py-Jinja2
- devel/py-babel
- devel/py-click
- devel/py-colorama
- devel/py-mergedeep
- devel/py-packaging
- devel/py-pathspec
- devel/py-platformdirs
- devel/py-python-dateutil
- devel/py-pyyaml
- devel/py-pyyaml-env-tag
- devel/py-six
- devel/py-watchdog
- devel/readline
- lang/python312
- lang/python315
- math/mpdecimal
- print/indexinfo
- textproc/expat2
- textproc/libyaml
- textproc/py-griffelib
- textproc/py-markdown
- textproc/py-markupsafe
- textproc/py-mkdocs
- textproc/py-mkdocs-autorefs
- textproc/py-mkdocs-get-deps
- www/py-ghp-import
Required by 1
Configuration
No options to configure.
- USES
- python
- Service scripts
- none
- Conflicts with
- ${PYTHON_PKGNAMEPREFIX}mkdocstrings-python-legacy
Files
distinfo 1
| File | Size | SHA256 |
|---|---|---|
| mkdocstrings_python-2.0.8.tar.gz | 201771 | 34545b54681cf0b212aab95394d37b0f5326a93b102f6ad1df3d965c79384c9d |
Master sites 1
- PYPI