PySphinxDoc is a tool for generating automatically API documentation for Python modules, based on their reStructuredText docstrings, using the sikit-learn theme, Bootstrap and Sphinx. Visit this module documentation for a live example.

Here is an exemple to generate the ‘pysphinxdoc’ module documentation:

  • first generate the rst files ‘sphinxdoc -v 2 -p $HOME/git/pysphinxdoc/ -n pysphinxdoc -o $HOME/git/pysphinxdoc/doc/’.
  • then generate the html files ‘cd $HOME/git/pysphinxdoc/doc; make raw-html’.

Expect a ‘$name_module/doc/source/_static’ folder containing a logo named ‘$name_module.png’ and an ‘carousel’ subfolder containing a list of images to be displayed in the index banner of the site.

Expect also an ‘axamples’ folders containing the gallery items as expected by the ‘sphinx_ext’ plugin.

The documentation is generated from the reStructuredText docstrings of each module, function or class.

In order to find module information, an ‘’ module is expected at the root of the module with mandatory keys:

  • NAME: the name of the module.
  • DESCRIPTION: the module short description that will be displayed in the banner.
  • SUMMARY: a text displayed with the carousel.
  • LONG_DESCRIPTION: the index page content.
  • URL: the module URL.
  • AUTHOR: the author of the module.
  • AUTHOR_EMAIL: the author e-mail.
  • __version__: the module version.

And optional keys:

  • EXTRANAME: a name that will be displayed in the last element of the navbar (default ‘PYSPHINXDOC’).
  • EXTRAURL: the associated URL (default the pySphinxDoc URL).