Skip to content

Commit a5c719a

Browse files
Create docs.yml
1 parent 5272aca commit a5c719a

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.github/workflows/docs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- 'develop'
7+
- 'github-action'
8+
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+
deploy:
25+
runs-on: ubuntu-latest
26+
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
31+
steps:
32+
- name: Checkout repository
33+
uses: actions/checkout@v4
34+
with:
35+
submodules: true
36+
37+
- name: Setup GitHub Pages
38+
uses: actions/configure-pages@v4
39+
40+
- name: Install Doxygen
41+
run: sudo apt-get install -y doxygen graphviz
42+
43+
- name: Build Docs
44+
run: python3 scripts/tools/run_doxygen.py
45+
46+
- name: Upload Docs
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
name: github-pages
50+
path: 'docs/html'
51+
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4
55+
with:
56+
artifact_name: github-pages

0 commit comments

Comments
 (0)