Skip to content

Merge pull request #1 from cedadev/update #1

Merge pull request #1 from cedadev/update

Merge pull request #1 from cedadev/update #1

Workflow file for this run

# Sample workflow for building and deploying a Sphinx site to GitHub Pages
name: Deploy Sphinx site to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: [main]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
# Default to bash
defaults:
run:
shell: bash
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install Poetry
run: |
pipx install poetry
- name: Install dependencies
run: poetry install --with docs
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build docs
run: |
poetry run sphinx-build -M html ./docs ./docs/_build -q -a
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/_build/html
# Deployment job
deploy:
environment:
name: github-pages
url:
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4