HS-API/.github/workflows/docs.yml at 1b46faeafbfbc84990f04b32cf55eedc5cdb90af · HackerSchool/HS-API · 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
name: docs

on:
  pull_request:
    branches: [ "main" ]
  push:
    branches: [ "main" ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout source
      uses: actions/checkout@v3
      with:
        fetch-depth: 0

    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: "3.x"

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install uv
        uv sync

    - name: Generate API docs
      run: uv run sphinx-apidoc -o docs/api-reference/generated . --separate

    - name: Build HTML
      run: uv run make -C docs html

  push-docs:
    needs: build
    if: github.event_name == 'push'  # only run after merge/push to main
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.x"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install uv
          uv sync

      - name: Generate API docs
        run: uv run sphinx-apidoc -o docs/api-reference/generated . --separate

      - name: Build HTML
        run: uv run make -C docs html

      - name: Push to docs build branch
        run: |
          git config user.name "github-actions"
          git config user.email "[email protected]"
          git checkout --orphan docs-build
          git --work-tree docs/_build/html add --all
          git --work-tree docs/_build/html commit -m "update docs [skip ci]"
          git push origin HEAD:docs-build --force