From 35836d588247c8cd35b21e061029d320f12da8a1 Mon Sep 17 00:00:00 2001 From: Florian Kurpicz Date: Mon, 8 Apr 2024 15:46:32 +0200 Subject: [PATCH] Autogenerate documentation (closes #79) (#720) * Autogenerate documentation (closes #79) This still requires changes in the configuration of the repository. * Add empty line at end of file --------- Co-authored-by: Niklas Uhl --- .github/workflows/gh-pages.yml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/workflows/gh-pages.yml diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 000000000..16400775e --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,34 @@ +name: Doxygen GitHub Pages Deploy Action + +on: + push: + branches: + - main + +jobs: + build-documentation: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + submodules: true + + # Build the HTML documentation + - name: Doxygen Action + uses: mattnotmitt/doxygen-action@v1.9.4 + with: + doxyfile-path: docs/Doxyfile + working-directory: . + additional-packages: perl build-base biblatex ghostscript + + # Deploy the HTML documentation to GitHub Pages + - name: GH Pages Deployment + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/html/ + enable_jekyll: false + allow_empty_commit: false + force_orphan: true + publish_branch: gh-pages