Skip to content

Commit 4ef01b1

Browse files
committed
Set up GitHub Actions to install Furo and build Site
1 parent 531dba9 commit 4ef01b1

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/workflows/gh-pages.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main # Or the default branch of your repository
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v2
15+
16+
- name: Set up Python
17+
uses: actions/setup-python@v2
18+
with:
19+
python-version: '3.x' # You can specify a particular version if needed
20+
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip
24+
pip install -r requirements.txt # Install dependencies listed in requirements.txt
25+
26+
- name: Build the documentation
27+
run: |
28+
python -m sphinx -b html sourcedir builddir # Adjust these to match your Sphinx setup
29+
30+
- name: Deploy to GitHub Pages
31+
uses: peaceiris/actions-gh-pages@v3
32+
with:
33+
github_token: ${{ secrets.GITHUB_TOKEN }}
34+
publish_dir: ./builddir # Path to where the built files are located

0 commit comments

Comments
 (0)