| Port variant | v13 |
| Summary | Legacy Python handler for mkdocstrings (3.13) |
| Package version | 0.2.4 |
| Homepage | https://mkdocstrings.github.io/python-legacy |
| Keywords | python |
| Maintainer | Python Automaton |
| License | Not yet specified |
| Other variants | v12 |
| Ravenports | Buildsheet | History |
| Ravensource | Port Directory | History |
| Last modified | 06 FEB 2025, 02:33:23 UTC |
| Port created | 06 FEB 2025, 02:33:23 UTC |
| single | mkdocstrings-python-legacyThe legacy Python handler for mkdocstrings. [image] [image] [image] [image] [image] ---[image] WARNING: We suggest using the new handler instead: [mkdocstrings-python]. ## Installation You can install this handler as a *mkdocstrings* extra: ```toml title="pyproject.toml" # PEP 621 dependencies declaration # adapt to your dependencies manager [project] dependencies = [ "mkdocstrings[python-legacy]>=0.18", ] ``` You can also explicitely depend on the handler: ```toml title="pyproject.toml" # PEP 621 dependencies declaration # adapt to your dependencies manager [project] dependencies = [ "mkdocstrings-python-legacy", ] ``` ## Preview ![mkdocstrings_python_gif] ## 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. - **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed to their [admonition] equivalent. *We do not support nested admonitions in docstrings!* - **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table of Contents, which is nicely display by the Material theme. Thanks to *mkdocstrings* cross-reference ability, you can reference other objects within your docstrings, with the classic Markdown syntax: `[this object][package.module.object]` or directly with `[package.module.object][]` - **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code of the Python object. |
| Build (only) |
python313:dev:std python-pip:single:v13 autoselect-python:single:std |
| Build and Runtime | python313:primary:std |
| Runtime (only) |
python-mkdocstrings:single:v13 python-mkdocs-autorefs:single:v13 python-pytkdocs:single:v13 |
| main | mirror://PYPIWHL/05/10/5bfba474535450b07423df0a7e2b467148bbe83db15c509caba5472905a5 |
| No other ports depend on this one. |