Template project to use doxygen, doxysphinx, doxylink, Sphinx and Read the Docs for online project documentation. As an example, a C++ library is added to this project (see libs folder) using CMake. The offline documentation can either be automatically build using CMake targets or locally using the terminal.
Take a look at the Read the Docs documentation here. You can also find additional information about the build process there.
- Combine doxygen, doxysphinx, doxylink, Sphinx and Read the Docs for online documentation
- Automated Online Documentation Build Process on Read the Docs server
- Automated Offline Documentation Build Process using CMake
-
doxygen - found at https://www.doxygen.nl/
-
doxysphinx - found at https://github.com/boschglobal/doxysphinx
-
doxylink - found at https://github.com/sphinx-contrib/doxylink
-
sphinx - found at https://www.sphinx-doc.org/en/master/
If you want to create the local documentation using CMake also the following requirements are necessary:
-
CMake v3.24+ - found at https://cmake.org/
-
C++ Compiler - i.e. MSVC, GCC, Clang
Note: You also need to be able to provide a CMake supported generator.
Microsoft devblog - Clear, Functional C++ Documentation with Sphinx + Breathe + Doxygen + CMake