tasktronaut/.github/workflows/documentation.yml at main · virtualstaticvoid/tasktronaut · 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: Documentation

on:
  release:
    types:
      - published
  workflow_dispatch: { }

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: ./.github/actions/preparation
      - name: Build API documentation
        working-directory: docs/
        run: uv run sphinx-apidoc -o source/api ../src/tasktronaut
      - name: Build documentation
        working-directory: docs/
        run: uv run make html
      - name: Upload documentation files
        uses: actions/upload-artifact@v5
        with:
          name: documentation
          path: docs/build/

  publish:
    name: Publish documentation
    runs-on: ubuntu-latest
    needs:
      - build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      contents: read
      pages: write
      id-token: write
    steps:
      - uses: actions/checkout@v5
      - uses: ./.github/actions/preparation
      - name: Retrieve documentation
        uses: actions/download-artifact@v5
        with:
          name: documentation
          path: docs/build/
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: docs/build/html/
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4