Sphinx is a software documentation tool "that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files)." Sphinx extracts the inline model, class and function documentation (docstrings) from the python code files to generate program documentation. For example.

Home page https://www.sphinx-doc.org/en/master/index.html


  • Starting with version 4.0.2
    • Added extension autodoc
    • Added extension TODO
  • 18 Jul '21 Updated to version 4.1.1
  • 29 May '22 Updated to version 5.0.0
  • 5 Sep '22 loaded version 5.1.1 on the laptop. Raspberry Pi still has version 5.0.0
  • 27 May '24 Loaded version 7.3.7 on the laptop with PyCharm IDE (and got it to work!)
    • Included extension autodoc
    • and extension TODO