Extending the documentation

Using reStructuredText

Useful resources:

• Basics of rST

• Documenting C++ with rST

Building a local copy of the docs

1. Create a Python virtual environment at .venv:

   $ python3 -m venv .venv
   

2. Activate the virtual environment:

   $ source .venv/bin/activate
   

3. Install the documentation pre-requisites:

   $ pip install -r docs/requirements.txt
   

4. Build the documentation:

   $ make -C docs html
   

5. Open the documentation in your favorite browser:

   $ <BROWSER> docs/_build/html/index.html