GitHub Action for generating and deploying Doxygen documentation to a GitHub pages branch. The action uses a docker container to run doxygen; the Dockerfile is also included in the repository.

As a test, the action is used to create the documentation of the repository itself.

To deploy docs on every push to the main branch, create a new file in the .github/workflows/ directory with the workflow name, for example, doxygen.yml:

on:
  push:
    branches:
      - arch
permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Action Doxygen and GitHub Pages
        id: ghaction
        uses: AgarwalSaurav/ghaction-doxygen-ghpages@release/v2
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          working-directory: .
          doxyfile-path: doc/Doxyfile
          html-output-folder: doc/html
          branch: gh-pages

The docker image is based on the archlinux image and contains doxygen and graphviz. Additionally, it contains latex for possibly generating PDFs in the future. It is located at ghcr.io.

See the docker directory and its documentation for more details.

This work is under an MIT license.

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

Based on:

• https://github.com/DenverCoder1/doxygen-github-pages-action
• https://github.com/mattnotmitt/doxygen-action