-
Notifications
You must be signed in to change notification settings - Fork 0
42 lines (38 loc) · 1.01 KB
/
docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
name: Deploy Docs to GitHub Pages
on:
release:
types: [ published ]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: 📂 Check-Out Repository
uses: actions/checkout@v3
- name: 🐍 Set Up Python
uses: actions/setup-python@v4
with:
python-version: "3.12"
cache: "pip"
cache-dependency-path: "pyproject.toml"
- name: ⏬ Install Required Packages
run: |
python -m pip install --upgrade pip
pip install .
pip install sphinx
- name: 🔨 Build Docs
run: sphinx-build -b html docs _site
- name: ⏫ Upload site artefact
uses: actions/upload-pages-artifact@v1
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: ⏫ Deploy to GitHub Pages
uses: actions/deploy-pages@v2