Generating the Documentation with SphinxDocs

You may generate documentation from the code using Sphinx.

To do this you must first install Sphinx by using the following command:

pip install -U sphinx

Afterwards, go to the sphinx_docs directory by doing:

cd sphinx_docs/

Now you can generate the documentation as follows:

make html

If you wish to clean the build directory, you may use this command:

make clean

The documentation has now been generated. To open it, go to the build directory, then into the html directory. Double click on the index.html to open it. Else, right click and click open with and pick a browser to open it with.