Marcs Notes

Home

❯

coding

❯

dev

❯

py

❯

Automated Documentation Generation with Sphinx

Automated Documentation Generation with Sphinx

07. Dez. 20251 Min. Lesezeit

Install

pip install sphinx 

Build with

sphinx-build -b html docs/source/ docs/build/html

Also use Read the Docs for deploying sphinx docs. Plus, use the VSCode autodoc extension to generate sphinx-style docstrings.

RTD-Tutorial: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

Link: https://www.sphinx-doc.org/en/master/tutorial/getting-started.html


Graphansicht

Erstellt mit Quartz v4.5.2 © 2025

  • GitHub