Docs & Doxygen

Markdown documentation is built using mdbook and API documentation is built using doxygen, and sphinx, and sphinx-markdown-builder.

Markdown documentation (docs)

Requirements

The markdown documentation is built using mdbook and sphinx.

Build command

If not already installed, be sure to install sphinx-markdown-builder.

pip install sphinx-markdown-builder

To build the markdown docs use the docs target in CMake.

cmake -B build
cmake --build build -- docs

API documentation (doxygen)

This is a link to a doxygen autogenerated code reference. Doxygen

Requirements

The API documentation is built using doxygen and sphinx, here are the needed tools for building it:

• doxygen
• dot from graphviz
• sphinx

Build command

To build the API docs use the doxygen target in CMake

cmake -B build
cmake --build build -- doxygen

Serving the docs locally

To start a server for local viewing of the docs, after building, run:

mdbook serve build/docs

mdbook will start a local server at http://localhost:3000 with the built docs.