mkdocstrings

Dev Tool — DocsPython N/AIntermediate

Auto-generate MkDocs pages from Python docstrings

Quick Info

Python Version
N/A
Dependencies
MkDocs, griffe, Jinja2, markdown, pymdown-extensions
Install
pip install 'mkdocstrings[python]'

Learn by Difficulty

Quick Example

python
# mkdocstrings
# Auto-generate MkDocs pages from Python docstrings
#
# Category: Dev Tool — Docs
# Related: N/A
print("mkdocstrings: Auto-generate MkDocs pages from Python docstrings")

mkdocstrings is part of the Python ecosystem. Auto-generate MkDocs pages from Python docstrings.

Try in Playground

Tags

tooldocumentationapi-docs