Python package documentation generation tool.

Note

Go to the end to download the full example code.

Basic example on how to generate a package documentation¶

A simple example of how to document a Python package, here ‘pysphinxdoc’.

# sphinx_gallery_thumbnail_path = "_static/pysphinxdoc.png"

import subprocess

Generate the rst auto documentation¶

cmd = ["sphinxdoc", "-v", "2", "-p", "$HOME/git/pysphinxdoc", "-n",
       "pysphinxdoc", "-o", "$HOME/git/pysphinxdoc/doc"]
subprocess.check_call(cmd)

Compute the html documentation¶

cmd = ["make", "raw-html"]
subprocess.check_call(cmd,  cwd="$HOME/git/pysphinxdoc/doc")

Estimated memory usage: 0 MB

Gallery generated by Sphinx-Gallery