OpenDoors/.github/workflows/docs.yml at master · codefenix-dev/OpenDoors · 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
91
92
93
94
95
96
97
98
99
100
101
name: Documentation

on:
  push:
    branches: [master]
    paths:
      - '.github/workflows/docs.yml'
      - 'docs/**'
      - 'historic/OPENDOOR.TXT'
      - 'mkdocs.yml'
      - 'mkdocs-release.yml'
      - 'include/OpenDoor.h'
      - 'include/ODStat.h'
      - 'README.md'
      - 'tools/check_api_docs.py'
      - 'tools/check_version.py'
      - 'VERSION'
      - 'release/examples/**'
      - 'tools/stage_release.py'
  pull_request:
    paths:
      - '.github/workflows/docs.yml'
      - 'docs/**'
      - 'historic/OPENDOOR.TXT'
      - 'mkdocs.yml'
      - 'mkdocs-release.yml'
      - 'include/OpenDoor.h'
      - 'include/ODStat.h'
      - 'README.md'
      - 'tools/check_api_docs.py'
      - 'tools/check_version.py'
      - 'VERSION'
      - 'release/examples/**'
      - 'tools/stage_release.py'
  workflow_dispatch:

permissions:
  contents: read

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-python@v7
        with:
          python-version: '3.x'
          cache: pip
          cache-dependency-path: docs/requirements.txt

      - name: Install documentation dependencies
        run: python -m pip install -r docs/requirements.txt

      - name: Check API reference coverage
        run: |
          python tools/check_api_docs.py
          PYTHONDONTWRITEBYTECODE=1 python tools/check_public_contract.py
          python tools/check_version.py

      - name: Build site
        run: mkdocs build --strict --site-dir site

      - name: Build offline site
        run: |
          mkdocs build --strict -f mkdocs-release.yml --site-dir offline-site
          if grep -R -E 'fonts\.(googleapis|gstatic)\.com' offline-site; then
            echo 'Offline documentation requires a remote font.'
            exit 1
          fi

      - name: Upload GitHub Pages artifact
        if: github.event_name != 'pull_request' && github.ref == 'refs/heads/master'
        uses: actions/upload-pages-artifact@v5
        with:
          path: site

  deploy:
    name: Deploy documentation
    if: github.event_name != 'pull_request' && github.ref == 'refs/heads/master'
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    concurrency:
      group: pages
      cancel-in-progress: false

    steps:
      - name: Configure GitHub Pages
        uses: actions/configure-pages@v6

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5