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 explicitly 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 parameter types or return types. It is even able to automatically add cross-references to other objects from your API, from the standard library or third-party libraries! See how to load inventories to enable it.
-
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.
-
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 displayed 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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | da0a54d7d46523a25a5227f0ecc74b491291bd9d36fc71445bfb0ea64283e287 |
|
MD5 | 3951253caeb24f5fe7e02af088e38371 |
|
BLAKE2b-256 | 28a9a09182a5cddb5b3b6b62b3b2af35f76ed3daf42ae43ef223d86eb876d1ea |
Hashes for mkdocstrings_python-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00e02b5d3d444f9abdec2398f9ba0c73e15deab78685f793f5801fd4d62a5b6f |
|
MD5 | 43b26348759f45cf610455d49c2ca878 |
|
BLAKE2b-256 | 207a1c21699cd4058264785c06804f3bfaa27e7e7b54ded1cf9e5857a8a5ffea |