Docs: Doxygen Documentation Deployment (#4264)

* doxygen documentation deployment * prepare for PR * change project number to develop * allow cancel-in-progress * test cancel * test cancel * disable cancel-in-progress * test * test * enable cancel-in-progress * temporarily shelve all workflows * temporarily shelve all workflows * test * recover one test * test * recover original status --------- Co-authored-by: zuxinjin <[email protected]>
deepmodeling · May 31, 2024 · 2061df9 · 2061df9
1 parent 24ee311
commit 2061df9
Show file tree

Hide file tree

Showing 2 changed files with 2,639 additions and 0 deletions.
diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml
@@ -0,0 +1,57 @@
+name: Doxygen Documentation Deployment
+
+on:
+  push:
+    # trigger the workflow whenever the "develop" branch has a push event
+    branches: ["doxygen", "develop"]
+    # FIXME The above "doxygen" branch is for PR review.
+    # It shall be removed once this workflow PR is merged.
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment and DO cancel in-progress runs
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Doxygen
+        run: sudo apt-get install doxygen graphviz -y
+        shell: bash
+
+      - name: Generate Doxygen Documentation
+        working-directory: ./doxygen
+        run: |
+          # download a better-looking style sheet
+          wget https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css
+          doxygen
+        shell: bash
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './doxygen/html'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+