Python Dokumentation

Mein bevorzugter Stil: sphinx/reStructuredText

Mein bevorzugtes Thema: The PyData Sphinx Theme — PyData Theme 0.16.1 documentation

• Domains — Sphinx documentation

Referenzbeispiele:

• subprocess — Subprocess management — Python 3.8.3rc1 documentation
• Das requests Paket ist relativ OK, wenn es um Dokumentation geht.

Start

Für Dependencies siehe typedschema

mkdir docs && cd docs
sphinx-quickstart

Numpy

• 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.

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