okmain/.github/workflows/python-docs.yml at main · si14/okmain · 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
66
67
name: python-docs

on:
  push:
    tags:
      - 'py-*'
  workflow_dispatch:

permissions:
  contents: read

jobs:
  # Build the documentation and upload the static HTML files as an artifact.
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          persist-credentials: false
      - uses: actions/setup-python@v6
        with:
          python-version: '3.14'

      - name: Install uv
        uses: astral-sh/setup-uv@v7

      - run: uv sync --package okmain
      - run: uv run --package okmain pdoc -o docs/py python/okmain

      - name: Add redirect from site root to the repo
        run: |
          cat > docs/index.html <<'HTML'
          <!doctype html>
          <html lang="en">
            <head>
              <meta charset="utf-8">
              <meta http-equiv="refresh" content="0; url=https://github.com/si14/okmain/">
              <link rel="canonical" href="https://github.com/si14/okmain/">
              <title>Redirecting…</title>
              <script>
                window.location.replace("https://github.com/si14/okmain/");
              </script>
            </head>
            <body>
              <p>Redirecting to <a href="https://github.com/si14/okmain/">the repo</a>…</p>
            </body>
          </html>
          HTML

      - uses: actions/upload-pages-artifact@v4
        with:
          path: docs/

  # Deploy the artifact to GitHub pages.
  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
  deploy:
    needs: build
    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