Documentation Work

Requirements

Sphinx

• Download Sphinx

Sphinx Requirements

• Install python-myst-parser

• Install pydata_sphinx_theme

Making Changes

• Navigate to the /doc directory.

• Remove the current documentation build if present:

On Linux/Mac use:

./make.sh clean

On Windows use:

./make.bat clean

• Make your changes.

• Rebuild the documentation:

On Linux/Mac use:

./make.sh html

On Windows use:

./make.bat html

• Ensure you get no warnings.

• Open the relevant html files from /doc/_build/html