Our Docs¶
Sphinx builds this documentation and we integrate C++ documentation built by Doxygen using the Breathe extension.
You can build the documentation locally by building the Doxygen .xml files followed by the Sphinx .html files, e.g.
$ cd ./docs && mkdir build && mkdir build/doxygen
$ doxygen doxygen/doxygen.dox && make html
which you can then view in your preferred browser e.g.
$ open build/html/index.html
Sphinx¶
Breathe¶
Doxygen¶
Contributing to Our Documentation¶
If you would like to contribute to the documentation, have questions or would like clarification or more detail on a particular topic, please contact us!.