napoleon (Sphinx) — Intermediate Playground

Sphinx extension for Google and NumPy style docstrings

Using napoleon (Sphinx) effectivelyRun locally

Install

pip install sphinx # napoleon is built-in

Python CodeRun locally

# napoleon (Sphinx) - effective usage
# Sphinx extension for Google and NumPy style docstrings
# Best practices and workflows
print("napoleon (Sphinx) best practices")

# napoleon (Sphinx) - effective usage
# Sphinx extension for Google and NumPy style docstrings
# Best practices and workflows
print("napoleon (Sphinx) best practices")

Following best practices with napoleon (Sphinx) 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 napoleon (Sphinx)