Skip to content

Documentation

In-code docstrings: Google vs. NumPy style vs. reStructuredText

Choosing between mkdocs (Markdown, simplicity) and sphinx (autodoc, extensibility)

Structuring docs/: landing page, API reference, tutorials, FAQ

Embedding examples, diagrams, and code snippets

Live preview (mkdocs serve / sphinx-autobuild) and deploying to GitHub/GitLab Pages