Documentation Setup

If you wish to build the documentation, you will need to install some requirements first. For the automatic code documentation, doxygen is required. Furthermore, you will need Python. Using Python, you can install other requirements such as Sphinx and Breathe, which can be found in the requirements.txt file located in the docs folder. They can be installed easily by running

pip install -r requirements.txt

After everything has been installed, you can now run

make html

from inside the docs directory to build the documentation. You may now view the built documentation by opening the index.html file located in docs/build/html.