Build the doc!

This page explains how to build the documentation on a local machine.

Dependencies

Description

The documentation is built using doxygen and a bunch of other tools, in particular:

• doxygen the C++ documentation generator;

• Sphinx the python documentation generator;

• sphinx-rtd-theme a Sphinx theme used to render the HTML version of the documentation;

• sphinx-sitemap a Sphinx extension to generate multi-version and multi-language sitemaps.org compliant sitemaps for the HTML version of a Sphinx documentation;

• sphinx-copybutton a Sphinx extension which automatically adds buttons on code-blocks environments to copy its content;

• Breathe the Sphinx plugin for integrating doxygen outputs into Sphinx.

For a detailed description on how these tools interact, please refer to this article.

Installation guide (Ubuntu)

sudo apt-get install doxygen # installs the last version of doxygen

sudo apt-get install python3-sphinx # installs the last version of Sphinx

sudo apt-get install python3-breathe # installs the last version of Breathe

pip3 install sphinx-sitemap sphinx-rtd-theme sphinx-copybutton # installs theme and extensions

Build instructions

By default, CMake automatically creates a doc target. All you have to do to build the documentation website is to build this target. For instance, inside a build directory, the following command can be used.

cmake .. && make doc

Note that you do not need to use make and use the following generic command.

cmake --build . --target doc