mkdocstrings — Intermediate Playground

Auto-generate MkDocs pages from Python docstrings

Using mkdocstrings effectivelyRun locally

Install

pip install 'mkdocstrings[python]'

Python CodeRun locally

# mkdocstrings - effective usage
# Auto-generate MkDocs pages from Python docstrings
# Best practices and workflows
print("mkdocstrings best practices")

# mkdocstrings - effective usage
# Auto-generate MkDocs pages from Python docstrings
# Best practices and workflows
print("mkdocstrings best practices")

Following best practices with mkdocstrings ensures a productive development workflow.

Challenge

Try modifying the code above to explore different behaviors. Can you extend the example to handle a new use case?

View all Intermediate examples for mkdocstrings