This Python package is an extension for MkDocs and its main purpose is the
automation of documentation from sources.
Features:
* Language-agnostic
* Multiple themes support
* Cross-references across pages
* Cross-references across sites
* Inline injection in Markdown
* Global and local configuration
* Watch source code directories
* Reasonable defaults
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 listed in the above command, you can pick from the names under the Packages section.
===> The following configuration options are available for py312-mkdocstrings-1.0.6:
CRYSTAL=on: Crystal language handler
====> Options available for the radio PYHANDLER: you can only select none or one of them
PYTHON=off: Python language handler
PYTHONLEGACY=off: Legacy Python language handler
===> Use 'make config' to modify these settings
textproc/py-mkdocstrings: Update to 0.30.0
* Remove no longer required workaround for remnant mypy files.
* Adjust the test suite as well as one more test now works with newer
versions of py-markdown.
Changelog:
https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.30.0
MFH: 2025Q3
textproc/py-mkdocstrings: Update to 0.29.1
* Adjust USE=python accordingly, because Python 3.8 is no longer
present in the ports tree after ca15850a2b13 while I'm here.
Changelog:
https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.29.1
MFH: 2025Q2
textproc/py-mkdocstrings: Update to 0.29.0
* For some time now, the test suite has been available in the current
sdist tarballs, so switch to PyPI, which is preferred for Python
ports, and remove related parts that are no longer needed.
Changelog since 0.27.0:
https://github.com/mkdocstrings/mkdocstrings/blob/0.29.0/CHANGELOG.md
MFH: No (not compatible with NetBox 4.1)
textproc/py-mkdocstrings: Update to 0.22.0
* Introduce CRYSTAL, PYTHON and PYTHONLEGACY options to reflect the
optional dependencies as noted in "pyproject.toml". Leave the last
two as non-default for now, because both are mutually exclusive due
conflicting dependencies.
* Switch to PEP517 build framework and get rid of the no longer
required workarounds for distutils.
* Remove the backported patch for Jinja2 3.1+ compatibility which is
also no longer needed.
* Convert the test suite to USE_PYTHON=pytest as well.
Changelogs since 0.17.0:
https://github.com/mkdocstrings/mkdocstrings/blob/0.22.0/CHANGELOG.md
all: remove explicit versions in USES=python for "3.x+"
The logic in USES=python will automatically convert this to 3.8+ by
itself.
Adjust two ports that only had Python 3.7 mentioned but build fine
on Python 3.8 too.
finance/quickfix: mark BROKEN with PYTHON
libtool: compile: c++ -DHAVE_CONFIG_H -I. -I../.. -I -I. -I.. -I../.. -I../C++
-DLIBICONV_PLUG -DPYTHON_MAJOR_VERSION=3 -Wno-unused-variable
-Wno-maybe-uninitialized -O2 -pipe -DLIBICONV_PLUG -fstack-protector-strong
-fno-strict-aliasing -DLIBICONV_PLUG -Wall -ansi
-Wno-unused-command-line-argument -Wpointer-arith -Wwrite-strings
-Wno-overloaded-virtual -Wno-deprecated-declarations -Wno-deprecated -std=c++0x
-MT _quickfix_la-QuickfixPython.lo -MD -MP -MF
.deps/_quickfix_la-QuickfixPython.Tpo -c QuickfixPython.cpp -fPIC -DPIC -o
.libs/_quickfix_la-QuickfixPython.o
warning: unknown warning option '-Wno-maybe-uninitialized'; did you mean
'-Wno-uninitialized'? [-Wunknown-warning-option]
QuickfixPython.cpp:175:11: fatal error: 'Python.h' file not found
^~~~~~~~~~
1 warning and 1 error generated.
Reviewed by: portmgr, vishwin, yuri
Differential Revision: <https://reviews.freebsd.org/D40568>
textproc/py-mkdocstrings: Add support for Jinja2 3.1
* The newer releases of py-mkdocstrings need some additional
dependencies, which are not yet available as ports.
Thus backport a patch of the 0.18.0 release to add compatibility for
Jinja2 3.1. This fixes the runtime regarding "contextfunction" that
was replaced with "pass_context" in Jinja2 3.1 after 23cc43859179.
* Bump PORTREVISION due package change.
Remove WWW entries moved into port Makefiles
Commit b7f05445c00f has added WWW entries to port Makefiles based on
WWW: lines in pkg-descr files.
This commit removes the WWW: lines of moved-over URLs from these
pkg-descr files.
Approved by: portmgr (tcberner)
Add WWW entries to port Makefiles
It has been common practice to have one or more URLs at the end of the
ports' pkg-descr files, one per line and prefixed with "WWW:". These
URLs should point at a project website or other relevant resources.
Access to these URLs required processing of the pkg-descr files, and
they have often become stale over time. If more than one such URL was
present in a pkg-descr file, only the first one was tarnsfered into
the port INDEX, but for many ports only the last line did contain the
port specific URL to further information.
There have been several proposals to make a project URL available as
a macro in the ports' Makefiles, over time.
(Only the first 15 lines of the commit message are shown above )
textproc/py-mkdocstrings: New port
This Python package is an extension for MkDocs and its main purpose is
the automation of documentation from sources.
Features:
* Language-agnostic
* Multiple themes support
* Cross-references across pages
* Cross-references across sites
* Inline injection in Markdown
* Global and local configuration
* Watch source code directories
* Reasonable defaults
WWW: https://github.com/mkdocstrings/mkdocstrings
