Skip to content

Update Actions for deploying GitHub Pages #2

Update Actions for deploying GitHub Pages

Update Actions for deploying GitHub Pages #2

Workflow file for this run

name: Build and Deploy Sphinx Documentation
on:
push:
branches: ["main"]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
ref: doc/api-reference
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_rtd_theme
- name: Build documentation
run: sphinx-build -b html docs/ docs/_build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3 # Use upload-pages-artifact instead of upload-artifact
with:
name: github-pages-artifact
path: docs/_build/html
# Deployment job
deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
with:
artifact_name: github-pages-artifact