Github-Documentation-With-Doxygen

Automatically deploy your documentation of your project without any CI pipelines. This is achieved by using github actions along with github pages.

Doxygen with auto deployment has been setup in this repository. The documentation for this repository is available at https://satu0king.github.io/Github-Documentation-With-Doxygen/

Doxygen - Documentation Setup

Skip this if you already have doxygen configured

Install doxygen
- macOS - brew install doxygen
- Ubuntu - sudo apt-get install -y doxygen
Create doxygen config file (Doxyfile). Run doxygen -g
Configure Doxyfile
- Set RECURSIVE to YES
- Set EXCLUDE and EXCLUDE_PATTERNS to exclude directories you don't want documented. Typically library code and plugins come here.
- Set PROJECT_NAME to the name of your project
Optionally add html and latex to .gitignore file
Document your code according to Doxygen guidlines
- Check src/main.c for C style documentation. Output can be seen here.
- Check src/main.cpp for C++ style documentation. Output can be seen here
- Check src/main.py for Python style documentation. Output can be seen here
Optionally run doxygen to generate documentation to see output documentation locally
- By default web documentation and pdf documentation files are generated in html and latex directories respectively.
- View web documentation at html/index.html
- Compile pdf documentation by running make in latex directory
- Class list can be seen here