python-gearbox/.github/workflows/docs.yml at master · efirvida/python-gearbox · 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
name: Docs

# Builds documentation on pull requests and master pushes (warnings are errors).
# Every master push publishes the successful build; pull requests never publish.
# Manual publication remains available from master with publish=true.
# One-time setup: Settings > Pages > Source: "GitHub Actions".

on:
  push:
    branches: [master]
  pull_request:
    paths: ["docs/**", "src/**", "pyproject.toml", ".github/workflows/docs.yml"]
  workflow_dispatch:
    inputs:
      publish:
        description: "Publish documentation from master to GitHub Pages"
        type: boolean
        required: true
        default: false

permissions:
  contents: read

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-python@v6
        with:
          python-version: "3.12"
      - run: pip install -e ".[docs]"
      - run: sphinx-build -W --keep-going -b html docs docs/_build/html
      - run: touch docs/_build/html/.nojekyll
      - uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_build/html

  deploy:
    needs: build
    if: github.ref == 'refs/heads/master' && (github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.publish))
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4