Chapter03

Software Architecture with C++, Second Edition

Software Architecture with C++, Second Edition, Published by Packt

Chapter 3: Functional and Nonfunctional Requirements

Autogenerated Documentation Demo

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

Install the following software:

• CMake
• A C++ compiler
• Sphinx
• ReadTheDocs Sphinx theme
• Breathe
• sphinx-mdinclude
• Doxygen

Building

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

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build .