OBDII/.github/workflows/docs-sphinx.yml at 4d0f1d2c3092a9ea982abea49d600083145a4195 · PaulMarisOUMary/OBDII · 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
name: Build Docs

on:
  push:
    paths:
      - "obdii/**"
      - "**/*.py"
      - "!tests/**/*.py"
      - "requirements.txt"
      - "pyproject.toml"
    branches: [ main ]
  pull_request:
    paths:
      - "obdii/**"
      - "**/*.py"
      - "!tests/**/*.py"
      - "requirements.txt"
      - "pyproject.toml"
    branches: [ main ]

  workflow_dispatch:

jobs:
  sphinx-docs:
    name: Build Documentation 📄
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

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

      - name: Install dependencies
        run: |
          python -m pip install -e .[docs]

      - name: Build documentation
        working-directory: docs
        run: |
          sphinx-build -b html -j auto -a -n -T -W --keep-going source build/html