Sphinx

Sphinx generates the HTML (and other) documentation from (only) reStructuredText (rst) files.

sphinx-quickstart creates the config file conf.py and a Makefile.

make html will then create html

Other format as python source files can be converted to rst after adding extension modules to conf.py

extensions = [
'sphinx.ext.autodoc'
'sphinx.ext.viewcode'
] 

autodoc makes the modules appear and viewcode makes the code visible

Then sphinx-apidoc -o <rast output dir><py code input dir>

The rst files created need then to be added to index.rst (without adding the .rst extension)


Linurs startpage