Documentation

Overview

LibRPA uses Sphinx toolchain to build its user documentation. C++ API documentation is generated using Doxygen and connected to Sphinx using Doxysphinx and doxylink. We also use the following packages to make the writing easier and prettify the documentation

• Sphinx RTD theme

• Sphinx design

• Sphinx copy-button

• MyST parser

• Doxygen Awesome

Build

To build the documentation, the mentioned prerequisites can be installed from PyPi

pip3 install -r docs/requirements.txt
pip3 install doxysphinx

or using conda

conda install -c conda-forge --file docs/requirements.txt
# unfortunately doxysphinx can only be installed from pypi
pip3 install doxysphinx

It is recommened to create a dedivated virtual environment to install the packages.

After successful install of the prerequisites, the document can be built by issuing the following make command under docs directory.

make html
# or simply
make

This will download the required style sheet and run the toolchain. The generated (HTML) documentation is under _build/html directory. You can preview the documentation by opening _build/html/index.html using any web browser.