C++ API Reference

The full Doxygen site for the C++ API now builds directly inside Read the Docs, so it inherits the same branch and tag versioning controls as the rest of this documentation set. Each RTD build runs Doxygen against the checked-out source tree and publishes the generated HTML bundle alongside the rest of the pages.

How this page works

  • conf.py renders a dedicated Doxyfile and executes Doxygen during the builder-inited step.

  • The HTML bundle is staged under _generated/cpp-api/ (ignored by git) and then copied to cpp-api/ so it is served by RTD under the current version.

  • This page immediately redirects to ../cpp-api/index.html so the Doxygen-rendered reference opens as a standalone documentation section.

Direct View

Loading the generated C++ API reference…

Local Builds

To preview these docs locally, make sure pixi has installed the toolchain (pixi run config) and then run:

pixi run docs-build

The command above mirrors Read the Docs by executing sphinx-build from docs/readthedocs/ and drops the Doxygen site into docs/readthedocs/_generated/cpp-api.