Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.47 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.47 KB

Software Architecture with C++, Second Edition

Software Architecture with C++: Designing Robust C++ Systems with Modern Architectural Practices, 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 3.28
  • GCC 15, Clang 20, MSVC 19.50
  • Sphinx
  • ReadTheDocs Sphinx theme
  • Breathe
  • sphinx-mdinclude
  • Doxygen

The C++ compiler in your IDE and the Conan profile must be compatible to compile examples from the IDE.

Assuming you're on Linux or using WSL. The examples are developed on Linux, but their compilation and functionality are also tested on macOS and Windows.

Python requirements files

Sphinx is a Python application that can be installed in a Python virtual environment. JetBrains IDEs, Visual Studio, Qt Creator and the others support these requirements files.

Building

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

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