Skip to content

Commit 1ab73fd

Browse files
committed
🐎 ci: Add workflow build docs
1 parent aff3e40 commit 1ab73fd

File tree

2 files changed

+63
-3
lines changed

2 files changed

+63
-3
lines changed

.github/workflows/build_docs.yml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Simple workflow for deploying static content to GitHub Pages
2+
name: Build Docs
3+
4+
on:
5+
workflow_dispatch:
6+
push:
7+
branches:
8+
- main
9+
paths:
10+
- "**"
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Single deploy job since we're just deploying
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
31+
runs-on: ubuntu-latest
32+
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v4
36+
37+
- name: Setup Pages
38+
uses: actions/configure-pages@v5
39+
40+
- name: Setup Python
41+
uses: actions/setup-python@v5
42+
with:
43+
python-version: '3.12'
44+
45+
- name: Build Docs
46+
run: |
47+
cd docs
48+
sudo apt-get install -y python3-sphinx
49+
pip3 install -r requirements.txt
50+
sphinx-build -M html ./ ./build
51+
52+
- name: Upload artifact
53+
uses: actions/upload-pages-artifact@v3
54+
with:
55+
# Upload entire repository
56+
path: 'docs/build'
57+
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

docs/requirements.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Pygments==2.16.1
2-
furo==2023.9.10
3-
sphinx==7.2.6
1+
Pygments==2.18.0
2+
furo==2024.7.18
3+
sphinx==7.4.7
44
sphinx_inline_tabs==2023.4.21

0 commit comments

Comments
 (0)