Documentation

Sphinx and the other needed packages are included in traveller/sphinx_source/docs_requirements.txt.

To setup Sphinx:

Install the required packages using

$ python -m pip install -r docs_requirements.txt

then change directory to the folder containing the source and build files for the documenatation

$ cd traveller/sphinx_source

Run the command below in the traveller/sphinx_source folder to generate HTML pages for the documentation.

$ make html

You can view the generated HTML pages in _build/html folder