doxyconfig

Table of Contents

• Usage

This is a common Doxygen config for LizardByte projects.

Usage

1. Add this repository as a submodule to your project.

   git submodule add https://github.com/LizardByte/doxyconfig.git third-party/doxyconfig

2. Place project specific Doxyfile config in ./docs/Doxyfile. You can overwrite anything from the common config here.

3. Add the following to your CMakeLists.txt file.

   option(BUILD_DOCS "Build documentation" ON)
   if(BUILD_DOCS)
       add_subdirectory(third-party/doxyconfig docs)
   endif()

4. Add the following to your .gitignore file.

   # doxyconfig
   docs/doxyconfig*

5. Optionally, add the following to the input list in your Doxyfile.

   INPUT += ../third-party/doxyconfig/docs/source_code.md

6. Optionally, copy the .readthedocs.yaml file to the root of your project.