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, follow these steps:

1. Create a Python virtual environment:

   python3 -m venv docs_venv
   

2. Activate this virtual environment and install nox:

   . ./docs_venv/bin/activate
   pip install nox
   

3. Build the documentation:

   nox -s docs
   

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

firefox doc/out/index.html &