Python sphinx

From wikinotes
Revision as of 12:42, 4 July 2022 by Will (talk | contribs) (→‎API Docs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Sphinx is a python program that is built to assist in the creation of technical documentation.
You can autogenerate API docs for various languages, or define free-form docs.

Documentation

sphinx docs http://www.sphinx-doc.org/en/master/contents.html
sphinx directives https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
sphinx napoleon docs http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html

Locations

${PROJECT}/source/conf.py config

Core

sphinx install
sphinx configuration
sphinx static files
sphinx hosting
sphinx usage
sphinx syntax
sphinx extending
sphinx extensions

API Docs

sphinx apidoc usage
sphinx apidoc configuration