# doxyconfig

**Repository Path**: pppppppppppppppppppp/doxyconfig

## Basic Information

- **Project Name**: doxyconfig
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-09
- **Last Updated**: 2025-12-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# doxyconfig

This is a common Doxygen config for LizardByte projects.

## Usage

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

   ```bash
   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.

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

4. Add the following to your `.gitignore` file.

   ```gitignore
   # doxyconfig
   docs/doxyconfig*
   ```

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

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

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

<details style="display: none;">
  <summary></summary>
  [TOC]
</details>