minyang / cpp_doxygen_sphinx

Tutorial for a C++ Doxygen CMake Sphinx Breathe Pipeline

Doxygen/CMake/Sphinx/Breathe for those of use who are totally lost

(I'm the one totally lost).

Read all this in a nicer format on Medium here.

The goal here is to set up the documentation for a C++ project. The end result will be documentation for C++ library in the ReadTheDocs theme hosted on GitHub, as shown below.

The final website is here.

Contents

There will be three parts split across these READMEs:

1. Link Getting some warnings about missing documentation to appear in the build process. This will be done by incorporating Doxygen into CMake.
2. Link Getting an actually nice (ReadTheDocs) website up and running. This will be done using the Doxygen/Sphinx/Breathe pipeline. I won't try to incorporate this step into the CMake file - it's usually done via GitHub actions anyways.
3. Link Getting GitHub actions to automatically build and host our documentation for us.

Sources

These notes are a compilation of what I learned from these nice sources, so all credit where it's due:

• Here
• Here
• Some million examples scattered around the web.