Skip to content

Latest commit

 

History

History
15 lines (9 loc) · 719 Bytes

File metadata and controls

15 lines (9 loc) · 719 Bytes

Code Documentation

Sphinx

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. Python code can include documentation right inside its source code. The default way of doing so relies on docstrings, which are defined in a triple quote format. To make your documentation look beautiful, you can take advantage of Sphinx, which is designed to make pretty Python documents. In order to tell Sphinx what and how to generate the documentation, Sphinx use the configuration file conf.py.

Build the Documentation

On a linux host run:

./generate_doc.sh

This will create a new directory, named _build with the Documentation.