TangShangjin/cmake-doxygen-sphinx

README

Introduction

This is a demo application which shows how to automatically generate documentation using Doxygen, Breathe and Sphinx.

This README file should be included in the docs as the main page.

Prerequisites

System Requirements

• Doxygen

sudo apt install doxygen

Python Packages

• Sphinx & Sphinx ReadTheDocs Theme
• Breathe
• m2r2

pip install sphinx sphinx_rtd_theme breathe m2r2

Building

To build the project, first cd to its directory, and then run:

cmake -S . -B build
cmake --build build

The documents with be generated in build/doc.