doc

Sphinx is used to generate the API and reference documentation for all packages from the skmad-suite.

Instructions to build the documentation

In addition to installing madarrays and its dependencies, install the Python packages needed to build the documentation by entering

pip install -r ../requirements/doc.txt

in the doc/ directory.

To build the HTML documentation, run:

make html

in the doc/ directory. This will generate a build/html subdirectory containing the built documentation.

To build the PDF documentation, run:

make latexpdf

You will need to have Latex installed for this.