autoemulate/.github/workflows/docs.yaml at aee3427def776e6180aec8b06fd692ce11aa57ed · alan-turing-institute/autoemulate · 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
name: Docs
on:
  push:
    branches:
      - main
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
    branches:
      - main
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
    contents: write
jobs:
    docs:
        if: github.event.pull_request.draft == false || github.event_name == 'push' || github.event_name == 'workflow_dispatch'
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
            - uses: actions/setup-python@v5
              with:
                python-version: 3.12
            - name: Install uv
              uses: astral-sh/setup-uv@v7
              with:
                python-version: 3.12
                enable-cache: true
                cache-suffix: docs
                activate-environment: true
            - uses: nikeee/setup-pandoc@v1
            - name: "Install autoemulate with extras: dev, docs"
              run: uv sync --extra dev --extra docs
            - name: "Run jupyterbook"
              run: jupyter-book build docs --all
            - name: "Deploy"
              uses: peaceiris/actions-gh-pages@v3
              if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs') }}
              with:
                    publish_branch: gh-pages
                    github_token: ${{ secrets.GITHUB_TOKEN }}
                    publish_dir: docs/_build/html/
                    force_orphan: true