Skip to content

Only allow docs to be built from main #12

Only allow docs to be built from main

Only allow docs to be built from main #12

Workflow file for this run

name: Sphinx
on:
# Runs on pushes targeting the default branch
push:
branches:
- main
# - docs
pull_request:
branches:
- main
# - docs
# 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
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- uses: abatilo/actions-poetry@v2
- name: Install the project dependencies
run: poetry install --with=docs
- name: Build HTML
run: cd docs && poetry run -- make html
- name: Upload artifacts
uses: actions/upload-pages-artifact@v3
with:
name: github-pages
path: docs/build/html
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4