Repository files navigation

GitHub Action for making and deploying Doxygen documentation to a GitHub pages branch

To deploy docs on every push to themain branch, create a new file in the.github/workflows/ directory calleddoxygen-gh-pages.yml with the following contents:

name:Doxygen GitHub Pages Deploy Actionon:push:branches:      -mainjobs:deploy:runs-on:ubuntu-latestpermissions:contents:writesteps:      -uses:DenverCoder1/doxygen-github-pages-action@v2.0.0with:github_token:${{ secrets.GITHUB_TOKEN }}

• github_token (required): GitHub token for pushing to repo. See thedocs for more info.
• branch (optional): Branch to deploy to. Defaults togh-pages.
• folder (optional): Folder where the docs are built. Defaults todocs/html.
• config_file (optional): Path of the Doxygen configuration file. Defaults toDoxyfile.
• target_folder (optional): Directory within the deployment branch to push to. Defaults to empty (root).
• doxygen_version (optional): Version of Doxygen to install. Defaults to1.9.6.NOTE - only works with 1.9.3 and higher versions

Here is an example of a.github/workflows/doxygen-gh-pages.yml file with more advanced configuration:

name:Doxygen GitHub Pages Deploy Actionon:push:branches:      -mainworkflow_dispatch:jobs:deploy:runs-on:ubuntu-latestpermissions:contents:writesteps:      -uses:DenverCoder1/doxygen-github-pages-action@v2.0.0with:github_token:${{ secrets.GITHUB_TOKEN }}branch:gh-pagesfolder:docs/htmlconfig_file:Doxyfiledoxygen_version:1.9.6

This action is a composite action containing the following steps:

Theactions/checkout step is used to checkout the repository with any submodules.

Doxygen and Graphviz are installed by running the following command:

sudo apt-get install doxygen graphviz -y

Doxygen documentation is generated by running the following command.

Set theconfig_file input option to changeDoxyfile to a different filename.

doxygen Doxyfile

Creating a .nojekyll file ensures pages with underscores work on GitHub Pages.

Set thefolder input option to changedocs/html to a different folder.

touch docs/html/.nojekyll

TheJamesIves/github-pages-deploy-action action is used to deploy the documentation to GitHub Pages.

Thefolder option determines which folder to deploy. By default, it isdocs/html.

Thebranch option determines which branch to deploy to. By default, it isgh-pages.

Thetarget_folder option determines which directory in the deployment branch to push to. By default, the root of the branch is overwritten.

This work is under anMIT license

If you like this project, give it a ⭐ and share it with friends!