| Port details |
- py-mkdocstrings-python Python handler for mkdocstrings
- 1.13.0 textproc
 =2      1.10.9Version of this port present on the latest quarterly branch. - Maintainer: kai@FreeBSD.org
- Port Added: 2023-08-31 05:48:23
- Last Update: 2024-12-29 10:12:42
- Commit Hash: 0192985
- People watching this port, also watch:: jdictionary, py311-Automat, py311-python-gdsii, py39-PyOpenGL, p5-Sane
- 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.
- 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 = 1735310061
SHA256 (mkdocstrings_python-1.13.0.tar.gz) = 2dbd5757e8375b9720e81db16f52f1856bf59905428fd7ef88005d1370e2f64c
SIZE (mkdocstrings_python-1.13.0.tar.gz) = 185697
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.26 : 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>=0.49 : textproc/py-griffe@py311
- py311-mkdocs-autorefs>=1.2 : textproc/py-mkdocs-autorefs@py311
- python3.11 : lang/python311
- There are no ports dependent upon this port
Configuration Options:- No options to configure
- Options name:
- textproc_py-mkdocstrings-python
- USES:
- python:3.9+
- FreshPorts was unable to extract/find any pkg message
- Master Sites:
|
| Commit History - (may be incomplete: for full details, see links to repositories near top of page) |
| Commit | Credits | Log message |
|---|
1.13.0
29 Dec 2024 10:12:42
 |
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.13.0
* Remove no-op GH_PROJECT (remnant of 83f2d2e890b3) while I'm here.
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.13.0 |
1.12.2
03 Nov 2024 10:13:40
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.12.2
* Support for Python 3.8 was dropped with the 1.12.0 release, adjust
USES=python accordingly. |
1.11.1
06 Oct 2024 12:52:24
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.11.1
Changelog since 1.10.9:
https://github.com/mkdocstrings/python/blob/1.11.1/CHANGELOG.md |
1.10.9
02 Sep 2024 10:38:38
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.10.9
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.10.9 |
1.10.8
18 Aug 2024 07:17:30
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.10.8
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.10.8 |
1.10.7
27 Jul 2024 12:53:58
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.10.7
* Switch back to PyPI because the tests are now available in the sdists
again since the 1.10.7 release.
Changelogs since 1.10.5:
https://github.com/mkdocstrings/python/releases/tag/1.10.7
https://github.com/mkdocstrings/python/releases/tag/1.10.6 |
1.10.5
13 Jul 2024 07:25:36
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.10.5
* Switch to GitHub to continue using the test suite, which is currently
not included with the recent sdist tarballs. This now makes it
possible to run all tests, some of which were not included in the
sdist.
Changelog since 1.10.3:
https://github.com/mkdocstrings/python/blob/1.10.5/CHANGELOG.md |
1.10.3
16 Jun 2024 08:09:08
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.10.3
Changelog since 1.10.0:
https://github.com/mkdocstrings/python/blob/1.10.3/CHANGELOG.md |
1.10.0
24 Apr 2024 03:58:46
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.10.0
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.10.0 |
1.9.2
05 Apr 2024 14:00:41
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.9.2
Changelog since 1.9.0:
https://github.com/mkdocstrings/python/blob/1.9.2/CHANGELOG.md |
1.9.0
16 Mar 2024 07:43:51
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.9.0
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.9.0 |
1.8.0
13 Jan 2024 11:23:49
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.8.0
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.8.0 |
1.7.5
03 Dec 2023 15:02:50
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.7.5
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.7.5 |
1.7.4
20 Nov 2023 11:25:43
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.7.4
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.7.4 |
1.7.3
31 Oct 2023 12:33:16
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.7.3
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.7.3 |
1.7.2
09 Oct 2023 10:25:52
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.7.2
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.7.2 |
1.7.1
01 Oct 2023 10:27:58
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.7.1
Changelog:
https://github.com/mkdocstrings/python/releases/tag/1.7.1 |
1.7.0
18 Sep 2023 05:14:16
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.7.0
Changelog since 1.6.2:
https://github.com/mkdocstrings/python/blob/1.7.0/CHANGELOG.md |
1.6.2
11 Sep 2023 03:16:07
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: Update to 1.6.2
Changelog since 1.6.0:
https://github.com/mkdocstrings/python/blob/1.6.2/CHANGELOG.md |
1.6.0
31 Aug 2023 05:43:40
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python: New port
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. |
As an Amazon Associate I earn from qualifying purchases.