Skip to content

Simplify release workflow 2 #22

Simplify release workflow 2

Simplify release workflow 2 #22

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [main]
workflow_dispatch: # Allow manual trigger
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: pip
cache-dependency-path: pyproject.toml
- name: Install dependencies
run: |
python -m pip install --upgrade pip
sudo apt install pandoc
pip install .[doc]
- name: Build Sphinx docs
working-directory: docs
# ``-W`` promotes warnings to errors so doc regressions break CI
# rather than slipping through silently; ``--keep-going`` reports
# every offender in one run instead of stopping at the first.
run: python -m sphinx -W --keep-going -b html source build/html
- name: Fix permissions
run: |
chmod -c -R +rX "./docs/build/html" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/build/html
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4