A Python handler for mkdocstrings.
Project description
mkdocstrings-python
A Python handler for mkdocstrings.
Installation
You can install this handler as a mkdocstrings extra:
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings[python]>=0.18",
]
You can also explicitely depend on the handler:
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings-python",
]
Preview
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 parameters types or return types. It is even able to automatically add cross-references to other objects from your API, from the standard library or from third-party libraries! See how to load inventories to enable it.
-
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. See Griffe's documentation on docstrings support.
-
Admonition support in Google docstrings: blocks like
Note:
orWarning:
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocstrings-python-0.7.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c334b382dca202dfa37071c182418a6df5818356a95d54362a2b24822ca3af71 |
|
MD5 | 45245194777e22a805b738f1d96739ea |
|
BLAKE2b-256 | fa6523ba18347beaf10e269266ffe920b154315c1fae404febbaab013be63ede |
Hashes for mkdocstrings_python-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a22060bfa374697678e9af4e62b020d990dad2711c98f7a9fac5c0345bef93c7 |
|
MD5 | 61ed1856e37f91fdffc5ec1205918e89 |
|
BLAKE2b-256 | a3171fa817ea13240ef09a86a7429c12ed4fd53957e07e956f33e457122d9e8b |