| Port details on branch 2025Q3 |
- py-mkdocstrings-python Python handler for mkdocstrings
- 2.0.2 textproc
 =0      2.0.1Version of this port present on the latest quarterly branch. - Maintainer: kai@FreeBSD.org
- Port Added: 2023-08-31 05:48:23
- Last Update: 2026-02-23 13:04:53
- Commit Hash: a9a8668
- Also Listed In: python
- License: ISCL
- WWW:
- https://github.com/mkdocstrings/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.
  ¦  ¦  ¦  ¦ 
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - There is no configure plist information for this port.
- USE_RC_SUBR (Service Scripts)
- no SUBR information found for this port
- Dependency lines:
-
- ${PYTHON_PKGNAMEPREFIX}mkdocstrings-python>0:textproc/py-mkdocstrings-python@${PY_FLAVOR}
- Conflicts:
- CONFLICTS_INSTALL:
- py311-mkdocstrings-python-legacy
- To install the port:
- cd /usr/ports/textproc/py-mkdocstrings-python/ && make install clean
- To add the package, run one of these commands:
- pkg install textproc/py-mkdocstrings-python
- pkg install py311-mkdocstrings-python
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above.
NOTE: This is a Python port. Instead of py311-mkdocstrings-python listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py311-mkdocstrings-python
- Package flavors (<flavor>: <package>)
- py311: py311-mkdocstrings-python
- distinfo:
- TIMESTAMP = 1771164825
SHA256 (mkdocstrings_python-2.0.2.tar.gz) = 4a32ccfc4b8d29639864698e81cfeb04137bce76bb9f3c251040f55d4b6e1ad8
SIZE (mkdocstrings_python-2.0.2.tar.gz) = 199124
Packages (timestamps in pop-ups are UTC):
- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- py311-pdm-backend>0 : devel/py-pdm-backend@py311
- python3.11 : lang/python311
- py311-build>=0 : devel/py-build@py311
- py311-installer>=0 : devel/py-installer@py311
- Test dependencies:
-
- py311-beautifulsoup>=4.12.3 : www/py-beautifulsoup@py311
- py311-inline-snapshot>=0.18.1 : devel/py-inline-snapshot@py311
- py311-mkdocs-material>=9.5 : textproc/py-mkdocs-material@py311
- py311-mkdocstrings>=0.30.0 : textproc/py-mkdocstrings@py311
- py311-ruff>=0.4 : devel/py-ruff@py311
- py311-pytest>=7,1 : devel/py-pytest@py311
- python3.11 : lang/python311
- Runtime dependencies:
-
- py311-griffe>=1.13.0 : textproc/py-griffe@py311
- py311-mkdocs-autorefs>=1.4 : textproc/py-mkdocs-autorefs@py311
- python3.11 : lang/python311
- This port is required by:
- for Run
-
- net-mgmt/netbox
Configuration Options:- No options to configure
- Options name:
- textproc_py-mkdocstrings-python
- USES:
- python
- FreshPorts was unable to extract/find any pkg message
- Master Sites:
|
As an Amazon Associate I earn from qualifying purchases.