MoBI-View/.github/workflows/docs.yaml at 4bc1338f23dcf7b60574cd97271d1be295ee22a8 · childmindresearch/MoBI-View · 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
name: Build and publish docs

permissions:
  contents: write

on:
  workflow_run:
    workflows: [Python Tests]
    types:
    - completed
    branches:
    - main

jobs:
  build-and-publish-docs:
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6
    - name: Setup venv
      uses: ./.github/actions/setup-venv
      with:
        install-lsl: 'true'
        python-version: '3.12'
    - name: Setup Qt environment
      uses: ./.github/actions/setup-qt-env
      with:
        os: ubuntu-latest
    - name: Fetch LFS files
      run: git lfs pull
    - uses: actions/setup-python@v5
      with:
        python-version: '3.11'
    - name: Install docs dependencies
      run: uv sync --group docs
    - name: Build docs
      run: |
        uv run pdoc src/MoBI_View -o docs_build -t docs/pdoc-theme --docformat google
        touch docs_build/.nojekyll
    - uses: JamesIves/github-pages-deploy-action@6c2d9db40f9296374acc17b90404b6e8864128c8
      with:
        folder: docs_build