Skip to content

Commit

Permalink
Autogenerate documentation (closes #79) (#720)
Browse files Browse the repository at this point in the history
* 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 <tim.uhl@kit.edu>
  • Loading branch information
kurpicz and niklas-uhl authored Apr 8, 2024
1 parent e2960b2 commit 35836d5
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 35836d5

Please sign in to comment.