Skip to content

Commit 39763fa

Browse files
committed
Add docs deployment workflow.
1 parent 75fc6ad commit 39763fa

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

.github/workflows/gh-pages.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ "v0.0.9-docs" ]
6+
7+
# Concurrency control to prevent parallel runs on the same PR
8+
concurrency:
9+
group: ${{ github.workflow }}-${{ github.ref }}
10+
cancel-in-progress: true
11+
12+
permissions:
13+
contents: write
14+
pull-requests: write
15+
checks: write
16+
issues: read
17+
18+
jobs:
19+
deploy_docs:
20+
name: Deploy the docs
21+
runs-on: ubuntu-latest
22+
timeout-minutes: 30
23+
steps:
24+
# - name: Install git LFS (and tools needed by hooks)
25+
# run: |
26+
# apt-get update
27+
# apt-get install -y --no-install-recommends git git-lfs clang-format ca-certificates make
28+
# git --version
29+
# git lfs version
30+
31+
# Checkout Code
32+
- name: Checkout Code
33+
uses: actions/checkout@v4
34+
with:
35+
clean: true
36+
fetch-depth: 0
37+
fetch-tags: true
38+
39+
# Build docs
40+
- name: Build docs
41+
run: |
42+
cd docs
43+
pip3 install -r requirements.txt
44+
make SPHINXOPTS=-W multi-docs
45+
touch ./_build/.nojekyll
46+
47+
# Deploy to gh-pages
48+
- name: Deploy to gh-pages
49+
uses: peaceiris/actions-gh-pages@v3
50+
with:
51+
github_token: ${{ secrets.GITHUB_TOKEN }}
52+
publish_dir: ./docs/_build

0 commit comments

Comments
 (0)