Skip to content

Release 1.2.1 (#345) #21

Release 1.2.1 (#345)

Release 1.2.1 (#345) #21

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
- master
# 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
steps:
- name: Check out the repository
uses: actions/checkout@v4
- name: Install Poetry
run: |
pipx install --pip-args "-c .github/workflows/constraints.txt" poetry
poetry --version
- name: Set up Python
uses: actions/[email protected]
with:
python-version: "3.11"
cache: "poetry"
- name: Install dependencies
run: |
poetry install
- name: Build doc with Sphinx
run: |
poetry run sphinx-build -W docs docs/_build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: "docs/_build"
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3