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.
| Repository | aarch64 | amd64 | armv6 | armv7 | i386 |
|---|---|---|---|---|---|
| FreeBSD:14:latest | 0.2.7 | 0.2.7 | - | 0.2.7 | 0.2.7 |
| FreeBSD:14:quarterly | 0.2.7 | 0.2.7 | n/a | 0.2.7 | 0.2.7 |
| FreeBSD:15:latest | 0.2.7 | 0.2.7 | n/a | 0.2.7 | 0.2.7 |
| FreeBSD:15:quarterly | 0.2.7 | 0.2.7 | n/a | n/a | n/a |
| FreeBSD:16:latest | 0.2.7 | 0.2.7 | 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}mkdocs-autorefs>=1.1: textproc/py-mkdocs-autorefs${PYTHON_PKGNAMEPREFIX}pytkdocs>=0.14: textproc/py-pytkdocs
Test 2
${PYTHON_PKGNAMEPREFIX}mkdocs-material>0: textproc/py-mkdocs-material${PYTHON_PKGNAMEPREFIX}mkdocstrings>=0.28.3: textproc/py-mkdocstrings
The full lists below include those, and their dependencies in turn.
All build dependencies 15
All 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-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-docstring_parser
- textproc/py-markdown
- textproc/py-markupsafe
- textproc/py-mkdocs
- textproc/py-mkdocs-autorefs
- textproc/py-mkdocs-get-deps
- textproc/py-pytkdocs
- www/py-ghp-import
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
| File | Size | SHA256 |
|---|---|---|
| mkdocstrings_python_legacy-0.2.7.tar.gz | 99605 | 1aa8a277a332fb0d49be3786de3fa18af7d8792e8d611f6ba8d550dc3a1ff8a1 |
Master sites 1
- PYPI
Commit history 0
No commits in the history this site was built from.