fastcs-secop/.github/workflows/documentation.yml at main · ISISComputingGroup/fastcs-secop · 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
name: sphinx

on: [push, pull_request, workflow_call]

jobs:
  docs:
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
      - uses: astral-sh/setup-uv@v7
        with:
          python-version: "3.12"
      - name: install requirements
        run: uv sync --extra doc
      - name: Sphinx build
        run: uv run sphinx-build -E -a -W --keep-going doc _build
      - name: run spellcheck
        run: uv run sphinx-build -E -a -W --keep-going -b spelling doc _build
      - name: Upload artifact
        uses: actions/upload-artifact@v7
        with:
          name: documentation
          path: |
            _build
          if-no-files-found: error
          retention-days: 7
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
        with:
          publish_branch: gh-pages
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: _build/
          force_orphan: true