rydstate/.github/workflows/documentation.yml at main · pairinteraction/rydstate · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
name: Documentation

on:
  push:
    branches: ["*"]
  pull_request:
    types: [opened, reopened, synchronize]

jobs:
  build_sphinx:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
    - uses: actions/checkout@v6
    - name: Setup uv project virtual environment
      uses: ./.github/actions/setup-uv
    - name: Install dependencies
      run: |
        sudo apt update
        sudo apt install -y pandoc
    - name: Build documentation
      working-directory: docs/
      run: uv run --no-project make html SPHINXOPTS="-W --keep-going"  # TODO also use -n in the future
    - name: Upload artifacts
      uses: actions/upload-artifact@v6
      with:
        name: docs
        path: docs/_build/html


  deploy_docs:
    needs: [build_sphinx]
    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
    - uses: actions/checkout@v6

    - name: Download artifacts docs
      uses: actions/download-artifact@v7
      with:
        name: docs
        path: public/sphinx/html

    - name: Deploy pages
      uses: JamesIves/github-pages-deploy-action@v4.8.0
      with:
        branch: gh-pages
        folder: public
        single-commit: true
        dry-run: ${{ !(github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) }}