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/
Skip this if you already have doxygen configured
doxygen
brew install doxygen
sudo apt-get install -y doxygen
doxygen -g
Doxyfile
RECURSIVE
to YES
EXCLUDE
and EXCLUDE_PATTERNS
to exclude directories you don't want documented. Typically library code and plugins come here. PROJECT_NAME
to the name of your projecthtml
and latex
to .gitignore
filedoxygen
to generate documentation to see output documentation locally
html
and latex
directories respectively.html/index.html
make
in latex
directorymain.yml
to .github/workflows/main.yml
gh-pages
branch in settings pagepublish_dir
in main.yml
is set correctly