cppwg/.github/workflows/docs.yml at develop · Chaste/cppwg · 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
51
52
53
54
55
name: docs

# Build the Sphinx docs on every push/PR, and deploy to GitHub Pages on develop.
on:
  push:
    branches: [develop]
  pull_request:
    branches: [develop]

# Allow one concurrent deployment.
concurrency:
  group: pages
  cancel-in-progress: false

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: "3.12"

      - name: Install docs dependencies
        run: pip install ".[docs]"

      - name: Build HTML
        # -W: fail on any warning so docstring/markup regressions are caught.
        run: sphinx-build -b html -W --keep-going doc doc/_build/html

      - name: Upload Pages artifact
        # Only the deploy job needs the artifact, but uploading on PRs too keeps
        # the build honest (the artifact is just discarded).
        uses: actions/upload-pages-artifact@v5
        with:
          path: doc/_build/html

  deploy:
    # Publish only from develop, not from pull requests.
    if: github.event_name == 'push' && github.ref == 'refs/heads/develop'
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5