Sphinx

What Sphinx Is

Sphinx is a Python application for generating documentation. It uses reStructuredText as its markup language.

Visit the Sphinx website http://sphinx-doc.org/

Why Sphinx is Used

• To generate API documentation from source code docstrings.
• To generate HTML pages from the reStructuredText files.

How Sphinx is Used

1. Create valid docstrings for code

2. Install Sphinx

3. Create a docs folder

4. Navigate to the docs folder

5. Put a copy of the modified Sphinx Makefile

6. Put a copy of the modified Sphinx Config (conf.py)

7. Create an index file: index.rs_

   • This is the main page of the documentation and must include a table of contents
   • The file extension is required for non-code based files to work with the modified Sphinx Makefile

8. Generate the documenation

   make html