UniEnv/.github/workflows/docs.yml at e2f1811be8cf2b09b264e5661ef20a6bafdbf9f1 · UniEnvOrg/UniEnv · 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
68
69
70
71
72
73
74
name: Deploy Docs

on:
  push:
    branches:
      - main
      - master
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"
      - "mkdocs.yml"
      - "README.md"
      - "pyproject.toml"
      - "unienv_data/**"
      - "unienv_interface/**"
  workflow_dispatch:

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

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

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: pip

      - name: Install documentation dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install ".[dev]"
          python -m pip install \
            mkdocs-material \
            "mkdocstrings[python]" \
            mkdocs-gen-files \
            mkdocs-literate-nav \
            mkdocs-section-index

      - name: Configure GitHub Pages
        uses: actions/configure-pages@v5

      - name: Build documentation site
        run: mkdocs build

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: site/

  deploy:
    if: github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
    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@v4