moddyz / CXXPythonDocs

Example documentation build for a project consisting of C++ libraries with python bindings.

CXXPythonDocs

Example documentation build for a project consisting of C++ libraries with python bindings.

Table of Contents

• Dependencies
• Building

Dependencies

The following dependencies are required:

• C++ compiler
• CMake (3.12 or greater)
• Python
• Doxygen
• Sphinx

The following sphinx plugins are required:

• breathe
• sphinx-tabs
• Read the Docs

Building

Example snippet for building this project:

mkdir build && cd build
cmake -DCMAKE_INSTALL_PREFIX="/apps/CXXPythonDocs/" ..
make install -j8

TODOs

• Discover and bail cmake configure if breathe is not installed.
• Sphinx build process should depend on doxygen XML build.
• C++ and Python side by side view