kuiper/.github/workflows/gh-pages.yml at main · analogdevicesinc/kuiper · 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
name: Build and Deploy GitHub Pages
on:
  push:
    branches:
      - main
      - dev
      - dev/*
    paths:
      - 'docs/**'
  pull_request:
    paths:
      - 'docs/**'

jobs:
  build-doc:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v5
      with:
        python-version: "3.x"

    - name: Install pip packages
      working-directory: docs
      run: |
        pip install pip --upgrade
        pip install -r requirements.txt

    - name: Build doc
      working-directory: docs
      run: |
        make html SPHINXOPTS='-W --keep-going'

    - name: Store the generated doc
      uses: actions/upload-artifact@v4
      with:
        name: html
        path: docs/_build/html

  deploy-gh-pages:
    runs-on: ubuntu-latest
    needs: build-doc
    permissions:
      contents: write
    if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'pull_request' }}

    steps:
    - uses: analogdevicesinc/doctools/gh-pages-deploy@action
      with:
        name: html