Skip to content

Commit d6aa334

Browse files
committed
Add CI step for doxygen
1 parent 4ce9ec7 commit d6aa334

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

.github/workflows/static.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Deploy documentation to Github Pages
2+
3+
on:
4+
push:
5+
branches: ["master"]
6+
7+
# Allows you to run this workflow manually from the Actions tab
8+
workflow_dispatch:
9+
10+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
17+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: false
21+
22+
jobs:
23+
deploy:
24+
environment:
25+
name: github-pages
26+
url: ${{ steps.deployment.outputs.page_url }}
27+
28+
runs-on: ubuntu-latest
29+
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
34+
- name: Setup Pages
35+
uses: actions/configure-pages@v4
36+
37+
- name: Install Doxygen
38+
run: sudo apt install doxygen && doxygen --version
39+
40+
- name: Install Graphviz
41+
run: sudo apt install graphviz
42+
43+
- name: Build docs
44+
run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=Release -DDSPLIB_BUILD_DOXYGEN=ON && cmake --build ${{github.workspace}}/build
45+
env:
46+
CXX: clang++
47+
48+
- name: Upload artifact
49+
uses: actions/upload-pages-artifact@v3
50+
with:
51+
path: '${{github.workspace}}/build/docs/doxygen/html/'
52+
53+
- name: Deploy to GitHub Pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)