v1.1.7 #20
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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@v4 | |
- name: 🐍 Set Up Python | |
uses: actions/setup-python@v5 | |
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@v3 | |
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@v4 |