Hyperactive/.github/workflows/docs.yml at main · hyperactive-project/Hyperactive · 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
name: Documentation

on:
  push:
    branches:
      - main
      - dev
    paths:
      - 'docs/**'
      - 'src/**'
      - '.github/workflows/docs.yml'
  pull_request:
    branches:
      - main
      - dev
    paths:
      - 'docs/**'
      - 'src/**'
      - '.github/workflows/docs.yml'

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

jobs:
  test-snippets:
    name: test-doc-snippets
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.10', '3.11', '3.12']
      fail-fast: false

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install dependencies
        run: |
          python -m pip install --no-cache-dir --upgrade pip
          python -m pip install --no-cache-dir -e ".[all_extras,test]"
          python -m pip install --no-cache-dir -r docs/requirements.txt

      - name: Show dependencies
        run: python -m pip list

      - name: Test documentation snippets
        run: |
          python -m pytest docs/tests/test_doc_snippets.py -v --tb=short

  build-docs:
    name: build-docs
    runs-on: ubuntu-latest
    needs: test-snippets

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Install dependencies
        run: |
          python -m pip install --no-cache-dir --upgrade pip
          python -m pip install --no-cache-dir -e ".[all_extras]"
          python -m pip install --no-cache-dir -r docs/requirements.txt

      - name: Show dependencies
        run: python -m pip list

      - name: Build documentation
        run: |
          cd docs && sphinx-build -b html source build/html -W --keep-going

      - name: Run doctest
        run: |
          cd docs && sphinx-build -b doctest source build/doctest || true

      - name: Upload documentation artifact
        uses: actions/upload-artifact@v4
        with:
          name: docs-html
          path: docs/build/html/
          retention-days: 7