linux/.github/workflows/doc.yml at bb030398fa1210803fca5e5d4b9841791573541c · analogdevicesinc/linux · 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
name: Build documentation

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
  pull_request:
    paths:
      - 'docs/**'

jobs:
  build-doc:
    runs-on: [self-hosted, repo-only]

    steps:
    - uses: analogdevicesinc/doctools/checkout@action

    - name: Install pip packages
      run: |
        python3.11 -m venv ~/venv
        source ~/venv/bin/activate
        pip3.11 install -r docs/requirements.txt --upgrade

    - name: Build doc
      working-directory: docs
      run: |
        source ~/venv/bin/activate
        make html SPHINXOPTS='-W --keep-going'

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

  deploy-doc:
    runs-on: [self-hosted, repo-only]
    permissions:
      contents: write
    needs: build-doc

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