https://github.com/lizardbyte/doxyconfig
Common doxygen config for LizardByte projects.
https://github.com/lizardbyte/doxyconfig
doxygen rtd
Last synced: 4 months ago
JSON representation
Common doxygen config for LizardByte projects.
- Host: GitHub
- URL: https://github.com/lizardbyte/doxyconfig
- Owner: LizardByte
- License: agpl-3.0
- Created: 2024-08-02T00:07:12.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-12T03:52:18.000Z (4 months ago)
- Last Synced: 2025-06-12T13:58:17.419Z (4 months ago)
- Topics: doxygen, rtd
- Language: JavaScript
- Homepage: https://docs.lizardbyte.dev/projects/doxyconfig
- Size: 80.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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.
[TOC]