Documentation

Each directory contains a README.md with the basic information, examples and usage. It does not however contain API documentation, which is built separately in this directory.

Requirements

To generate documentation you need to install meson and ninja.

The code is documented with Doxygen JavaDoc style, a prettified documentation also requires breathe, Sphinx, Sphinx tabs and Sphinx Read the Docs theme for building sane documentation pages.

You can install dependencies with pip:

pip install -U Sphinx sphinx-tabs sphinx_rtd_theme breathe
# Alternatively
pip install -r doc/requirements.txt

Building documentation

If you satisfy the requirements, the documentation will be generated to doc/html directory. You must be in the root directory of the project.

It may be needed to initialize git submodules git submodule update --init --recursive.

$ meson setup build_dir -Ddoc=enabled
$ ninja -C build_dir doc