Browse Source

added gh-pages action to deploy doxygen generated doc

Richard Gill 10 months ago
parent
commit
d30fbc04da
1 changed files with 26 additions and 0 deletions
  1. 26 0
      .github/workflows/docs.yml

+ 26 - 0
.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Documentation on github.io
+
+on:
+  push:
+    branches: [ github.io ]
+
+jobs:
+  build-documentation:
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout
+      uses: actions/checkout@v4
+    - name: apt-update
+      run: sudo apt-get update -qq
+    - name: apt-get doxygen
+      run: sudo apt-get install -y doxygen
+    - name: build doc
+      run: make docs
+    - name: deploy
+      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