Python Dokumentation

Für Python Modul-Dokumentation nutze ich NumPy syntax:

• numpydoc – Numpy’s Sphinx extensions
• Style guide — numpydoc Manual
• Example NumPy Style Python Docstrings — napoleon 0.7 documentation

sphinx-napoleon bietet Unterstützung für dieses Format.

Standard Python Dokumentation

• Domains — Sphinx documentation

Referenzbeispiel: subprocess — Subprocess management — Python 3.8.3rc1 documentation

Formatting

With GitHub - PyCQA/docformatter: Formats docstrings to follow PEP 257

docformatter --in-place --wrap-summaries 111 --wrap-descriptions 111 lib/src/util.py

Dokumente mit Codebeispielen, Resultaten und Grafiken (aka Rmd, jupyter, Rmarkdown)

• Quarto - Tutorial: Hello, Quarto

Functional Code documentation

functools

See also

• coding style - What are the most common Python docstring formats? - Stack Overflow
• Documenting Python Code: A Complete Guide – Real Python