adcp-client-python/.github/workflows/docs.yml at main · adcontextprotocol/adcp-client-python · 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
61
62
63
64
65
name: Build and Deploy Docs

on:
  push:
    branches: [main]
  release:
    types: [published]

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

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

jobs:
  docs:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: '3.11'

      - name: Install uv
        uses: astral-sh/setup-uv@v8.1.0

      - name: Install dependencies
        run: |
          uv pip install --system -e ".[docs]"

      - name: Build docs
        run: |
          python - <<'PY'
          import adcp
          from pdoc import cli

          # Parent-package exclusions are checked before pdoc imports submodules.
          # Keep in sync with the tombstones restored by scripts/post_generate_fixes.py.
          adcp.__pdoc__ = {
              **getattr(adcp, "__pdoc__", {}),
              "types.domains.enums.format_category": False,
          }
          cli.main(cli.parser.parse_args(["--html", "--output-dir", "docs/api", "adcp"]))
          PY

      - name: Configure Pages
        uses: actions/configure-pages@v6

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs/api/adcp

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5
        with:
          artifact_name: github-pages