| Port details |
- py-mkdocstrings-python-legacy Legacy Python handler for mkdocstrings
- 0.2.4 textproc
 =2      0.2.3Version of this port present on the latest quarterly branch. - Maintainer: kai@FreeBSD.org
- Port Added: 2023-08-31 05:48:27
- Last Update: 2024-11-03 19:50:29
- Commit Hash: 45269ff
- 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-legacy
- Description:
- This Python handler for the "mkdocstrings" package uses PyTkDocs
(= textproc/py-pytkdocs) 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 pytkdocs.
* Support for type annotations: pytkdocs collects your type annotations and
mkdocstrings uses them to display parameters types or return types.
* Recursive documentation of Python objects: just use the module dotted-path as
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.
  ¦  ¦  ¦  ¦ 
- 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-legacy>0:textproc/py-mkdocstrings-python-legacy@${PY_FLAVOR}
- Conflicts:
- CONFLICTS_INSTALL:
- py311-mkdocstrings-python
- To install the port:
- cd /usr/ports/textproc/py-mkdocstrings-python-legacy/ && make install clean
- To add the package, run one of these commands:
- pkg install textproc/py-mkdocstrings-python-legacy
- pkg install py311-mkdocstrings-python-legacy
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-legacy listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py311-mkdocstrings-python-legacy
- Package flavors (<flavor>: <package>)
- py311: py311-mkdocstrings-python-legacy
- distinfo:
- TIMESTAMP = 1730629881
SHA256 (mkdocstrings_python_legacy-0.2.4.tar.gz) = 36d160ac7af5a3cec764eeb66522f42a116088a41289e04372592b91e14abbbc
SIZE (mkdocstrings_python_legacy-0.2.4.tar.gz) = 97213
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-mkdocs-material>0 : textproc/py-mkdocs-material@py311
- py311-mkdocstrings>0 : textproc/py-mkdocstrings@py311
- py311-pytest>=7,1 : devel/py-pytest@py311
- python3.11 : lang/python311
- Runtime dependencies:
-
- py311-mkdocs-autorefs>=1.1 : textproc/py-mkdocs-autorefs@py311
- py311-pytkdocs>=0.14 : textproc/py-pytkdocs@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-legacy
- 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 |
|---|
0.2.4
03 Nov 2024 19:50:29
 |
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python-legacy: Update to 0.2.4
* Remove no longer required workaround for "pyproject.toml".
* Enable all tests from the test suite, which are now packaged in the
recent sdists.
Changelog:
https://github.com/mkdocstrings/python-legacy/releases/tag/0.2.4 |
0.2.3
31 Aug 2023 05:44:11
|
Kai Knoblich (kai) |
textproc/py-mkdocstrings-python-legacy: New port
This Python handler for the "mkdocstrings" package uses PyTkDocs
(= textproc/py-pytkdocs) 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 pytkdocs.
* Support for type annotations: pytkdocs collects your type annotations
and mkdocstrings uses them to display parameters types or return
types.
* Recursive documentation of Python objects: just use the module
dotted-path as 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. |
As an Amazon Associate I earn from qualifying purchases.