Skip to main content

[pysphinxdoc] API Documentation Generation Tool.

Project description

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 execute ‘sphinxdoc -v 2 -p $HOME/git/pysphinxdoc/ -n pysphinxdoc -o $HOME/git/pysphinxdoc/doc/’ and then in the $HOME/git/pysphinxdoc/doc/ folder ‘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.

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.

  • 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).

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysphinxdoc-1.0.0.tar.gz (301.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page