pdoc — Intermediate Playground

Auto-generate API docs from Python docstrings (simple alternative to Sphinx)

Using pdoc effectivelyRun locally

Install

pip install pdoc

Python CodeRun locally

# pdoc - effective usage
# Auto-generate API docs from Python docstrings (simple alternative to Sphinx)
# Best practices and workflows
print("pdoc best practices")

# pdoc - effective usage
# Auto-generate API docs from Python docstrings (simple alternative to Sphinx)
# Best practices and workflows
print("pdoc best practices")

Following best practices with pdoc 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 pdoc