cpp-documentation-example

https://github.com/TartanLlama/cpp-documentation-example

An example of setting up Sphinx for C++ and building with CMake and Read the Docs

See the documentation here

Dependencies

• CMake
• Doxygen
• Sphinx
• Breathe
• sphinx_rtd_theme

Setup

Use python3 by default

sudo ln -sf /usr/bin/python3 /usr/bin/python

Conda Setup

conda env create --file environment.yml
conda env create --file environment.yml --force  # if env already exists
conda activate docu-eval

conda deactivate
conda env remove -n docu-eval

Installing Conda Packages

conda install -c conda-forge doxygen

Building

mkdir build && cd build
cmake ../src
cmake --build .

Building and Viewing Doxygen Generated Docs

cd docs/
doxygen