Skip to content

Commit c030b54

Browse files
authored
Merge pull request #4 from CASP-Systems-BU/elimbaum-patch-1
Generate docs
2 parents 2809df0 + ea05793 commit c030b54

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

.github/workflows/doxygen.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy doxygen to Pages
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["main"]
7+
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
18+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: false
22+
23+
jobs:
24+
# Single deploy job since we're just deploying
25+
deploy:
26+
environment:
27+
name: github-pages
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
- name: Setup Pages
34+
uses: actions/configure-pages@v5
35+
36+
- name: Install Doxygen
37+
run: |
38+
wget https://www.doxygen.nl/files/doxygen-1.14.0.linux.bin.tar.gz
39+
tar xvzf doxygen-1.14.0.linux.bin.tar.gz
40+
cd doxygen-1.14.0
41+
sudo make install
42+
working-directory: ${{ runner.temp }}
43+
44+
- name: Build Docs
45+
run: ./scripts/generate-docs.sh
46+
47+
- name: Upload artifact
48+
uses: actions/upload-pages-artifact@v3
49+
with:
50+
# Upload entire repository
51+
path: 'doc/sphinx'
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)