Python sphinx: Difference between revisions
From wikinotes
| Line 52: | Line 52: | ||
| [[sphinx apidoc usage]] | | [[sphinx apidoc usage]] | ||
|- | |- | ||
| [[sphinx | | [[sphinx apidoc configuration]] | ||
|- | |- | ||
|} | |} | ||
</blockquote><!-- API Docs --> | </blockquote><!-- API Docs --> | ||
Latest revision as of 12:42, 4 July 2022
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.pyconfig
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
