Skip to content

C++ Template for CMake + Google Test + Doxygen + Sphinx

Notifications You must be signed in to change notification settings

pbudzyns/cpp_tests_and_docs_template

Repository files navigation

Template for CMake project with GoogleTest

Basic usage

mkdir build && cd build
cmake ..
make && make test

Template also includes Github Action Workflow that runs the tests.

Pre-commit hook

This template contains simple pre-commit hook that runs clang-format, cpplint and ctest.

To enable simply run configure script:

./configure.sh

Building documentation

Install requirements

apt install doxygen graphviz
pip install -r requirements.txt

Run build

cd docs/sphinx && make build-docs

Deploying documentation

Template includes GitHub action that deploys buit docs to the repository page. (See Settings->Pages for reference). You can see the docs page here: https://pbudzyns.github.io/cpp_tests_and_docs_template

About

C++ Template for CMake + Google Test + Doxygen + Sphinx

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published