Sphinx usage
From wikinotes
Sphinx is made to be extremely simple to run, a makefile is created in your configured directory (generally doc), you simply need to go in there, and type make alongside the format you want rendered.
Make sure that either in conf.py
or on your shell you have
the library that you are documenting in your PYTHONPATH
environment
variable.
Commandline
sphinx-quickstart # create project make clean # delete builds make html # build docs sphinx-build -P # pdb if unable to build docs