Our Docs

Note

Please consider that this project is under active development and our documentation is a work in progress.

We use Sphinx to build our documentation. Through the Breathe extension we integrate C++ documentation created using Doxygen. You can build our documentation locally by building the Doxygen .xml files followed by the Sphinx .html files, which you can then view in your preferred browser. E.g. With uv and doxygen installed you can do the following (hint: you may first want to see how to setup an environment<environment> for CLEO development which has uv and doxygen installed):

$ cd ~/CLEO/docs && mkdir -p build/doxygen
$ doxygen doxygen/doxygen.dox && uv run make html
$ open build/html/index.html

If you would like to contribute to the documentation, have questions or would like clarification or addition to the documentation about a particular topic, please contact us! or open a new issue on our GitHub repository.