Skip to content

[pre-commit.ci] pre-commit autoupdate #5

[pre-commit.ci] pre-commit autoupdate

[pre-commit.ci] pre-commit autoupdate #5

Workflow file for this run

name: docs
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install Hatch
run: pipx install hatch
- name: Build documentation
run: hatch run docs:build
- name: Upload documentation
uses: actions/upload-artifact@v4
with:
name: docs
path: 'docs/_build/html'
retention-days: 1
deploy:
needs: build
if: contains('refs/heads/main', github.ref)
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Download documentation
uses: actions/download-artifact@v4
with:
name: docs
- name: Setup GitHub Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4