Search engines are not blocked. Try using "site:www.freshports.org" and your search terms.
Volunteers wanted to help translate FreshPorts
Searches without login should now work. You must get asked to click a button.
Port details on branch 2023Q4
py-mkdocstrings-python Python handler for mkdocstrings
2.0.8_1 textproc Σ=0 search for ports that depend on this port Find issues related to this port Report an issue related to this port View this port on Repology. pkg-fallout 2.0.8_1Version of this port present on the latest quarterly branch.
Maintainer: kai@FreeBSD.org search for ports maintained by this maintainer
Port Added: 2023-08-31 05:48:23
Last Update: 2026-09-06 17:04:37
Commit Hash: 45ea4cf
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.
Homepage    cgit ¦ Codeberg ¦ GitHub ¦ GitLab ¦ SVNWeb - no subversion history for this port

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:
  • py312-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 py312-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 py312-mkdocstrings-python listed in the above command, you can pick from the names under the Packages section.
PKGNAME: py312-mkdocstrings-python
Package flavors (<flavor>: <package>) #
  • py312: py312-mkdocstrings-python
distinfo: #
TIMESTAMP = 1788276252 SHA256 (mkdocstrings_python-2.0.8.tar.gz) = 34545b54681cf0b212aab95394d37b0f5326a93b102f6ad1df3d965c79384c9d SIZE (mkdocstrings_python-2.0.8.tar.gz) = 201771

No package information for this port in our database #
Sometimes this happens. Not all ports have packages. Perhaps there is a build error. Check the fallout link: pkg-fallout
Dependencies #
NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
Build dependencies: #
  1. py312-pdm-backend>0 : devel/py-pdm-backend@py312
  2. python3.12 : lang/python312
  3. py312-build>=0 : devel/py-build@py312
  4. py312-installer>=0 : devel/py-installer@py312
Test dependencies: #
  1. py312-beautifulsoup4>=4.12.3 : www/py-beautifulsoup4@py312
  2. py312-inline-snapshot>=0.18.1 : devel/py-inline-snapshot@py312
  3. py312-mkdocs-material>=9.5 : textproc/py-mkdocs-material@py312
  4. py312-mkdocstrings>=0.30.0 : textproc/py-mkdocstrings@py312
  5. py312-ruff>=0.4 : devel/py-ruff@py312
  6. py312-pytest>=7,1 : devel/py-pytest@py312
  7. python3.12 : lang/python312
Runtime dependencies: #
  1. py312-griffelib>=2.0 : textproc/py-griffelib@py312
  2. py312-mkdocs-autorefs>=1.4 : textproc/py-mkdocs-autorefs@py312
  3. python3.12 : lang/python312
This port is required by: #
for Run #
  1. net-mgmt/netbox
for Test #
  1. textproc/py-mkdocstrings

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: #
Expand this list (2 items)
Collapse this list.
  1. https://files.pythonhosted.org/packages/source/m/mkdocstrings_python/
  2. https://pypi.org/packages/source/m/mkdocstrings_python/
Collapse this list.

There are no commits on branch 2023Q4 for this port