python-agent-template/.github/workflows/python-docs.yml at main · pmalarme/python-agent-template · 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
name: "Python: docs"

on:
  workflow_dispatch:
  push:
    branches: ["main"]
    paths:
      - "docs/**"
      - "agents/*/docs/**"
      - "agents/*/src/**"
      - "scripts/generate_docs.py"
      - "pyproject.toml"

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  build:
    name: build docs
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

      - name: Setup Python environment
        uses: ./.github/actions/setup-python-env
        with:
          include-docs: "true"
          extra-args: "--all-packages"

      - name: Build documentation
        run: uv run python scripts/generate_docs.py

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
        with:
          path: docs/generated

  deploy:
    name: deploy to GitHub Pages
    needs: build
    runs-on: ubuntu-latest

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5