| Port details |
- py-mkdocstrings-python Python handler for mkdocstrings
- 1.7.0 textproc
 =0      Port not present on quarterlyThis is expected as this port was created during this quarter. - Maintainer: kai@FreeBSD.org
- Port Added: 2023-08-31 05:48:23
- Last Update: 2023-09-18 05:14:16
- Commit Hash: e75369a
- Also Listed In: python
- License: ISCL
- 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.
  ¦  ¦  ¦  ¦  - 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:
- py39-mkdocstrings-python-legacy
- Conflicts Matches:
-
There are no Conflicts Matches for this port. This is usually an error.
- 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 py39-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 py39-mkdocstrings-python listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py39-mkdocstrings-python
- Package flavors (<flavor>: <package>)
- py39: py39-mkdocstrings-python
- distinfo:
- TIMESTAMP = 1694958208
SHA256 (mkdocstrings_python-1.7.0.tar.gz) = 5dac2712bd38a3ff0812b8650a68b232601d1474091b380a8b5bc102c8c0d80a
SIZE (mkdocstrings_python-1.7.0.tar.gz) = 30400
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:
-
- py39-pdm-backend>0 : devel/py-pdm-backend@py39
- python3.9 : lang/python39
- py39-build>=0 : devel/py-build@py39
- py39-installer>=0 : devel/py-installer@py39
- Test dependencies:
-
- py39-mkdocstrings>0 : textproc/py-mkdocstrings@py39
- py39-pytest>=7,1 : devel/py-pytest@py39
- python3.9 : lang/python39
- Runtime dependencies:
-
- py39-griffe>=0.35 : textproc/py-griffe@py39
- python3.9 : lang/python39
- There are no ports dependent upon this port
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:
|
| Commit History - (may be incomplete: for full details, see links to repositories near top of page) |
| Commit | Credits | Log message |
|---|
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.