Writing documentation¶

This documentation is written in reStructured Text, formatted by Sphinx, and published online by Read the Docs.

Authoring¶

The source for all of the documentation is located in the doc/src directory, located within the mcasopt directory. If you are not familiar with reStructured Text, then see this reference for an introduction to the concepts and syntax.

Building¶

To build the documentation on Spartan, follow these steps.

Connect to Spartan.
```
ssh spartan.hpc.unimelb.edu.au
```
Load the required Python module, Python/3.6.4-intel-2017.u2.
```
module load Python/3.6.4-intel-2017.u2
```
Enter the mcasopt directory and install the packages required to build the documentation.
```
cd mcasopt
pip install --user --requirement doc/requirements.txt
```
Build the documentation:
```
python setup.py build_sphinx
```

The documentation will be published to doc/out/html and can be viewed in a browser.