particula/.github/workflows/mkdocs.yml at main · uncscode/particula · 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
name: mkdocs

on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main
  merge_group:
    branches: [ main ]

jobs:
  blds:
    runs-on: ubuntu-latest
    concurrency:
      group: pages-${{ github.head_ref || github.ref_name }}
      cancel-in-progress: true
    steps:
        - name: Check out code
          uses: actions/checkout@v6
          with:
            persist-credentials: false

        - name: Set up Python 3.13
          uses: actions/setup-python@v6.2.0
          with:
            python-version: '3.13'
            cache: 'pip' # caching pip dependencies

        - name: Install dependencies
          run: |
            pip install jupyter-book ghp-import
            pip install mkdocs mkdocs-material[imaging] mkdocs-jupyter mkdocstrings[python] griffe mkdocs-gen-files mkdocs-literate-nav

        - name: Install particula package
          run: pip install -e .

        - name: Build MkDocs site with mkdocstrings
          run: mkdocs build

        - name: Deploy to GitHub Pages (on push or merge_group)
          if: ${{
            github.event_name == 'merge_group'
            || (github.event_name == 'pull_request' && github.event.pull_request.merged)
            || (github.event_name == 'push')
            }}
          uses: JamesIves/github-pages-deploy-action@v4
          with:
            branch: gh-pages
            folder: site  # Assuming mkdocs build output is the default 'site' directory

        - name: Preview Documentation (on PR)
          if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && github.actor != 'dependabot[bot]' }}
          uses: rossjrw/pr-preview-action@v1
          with:
            source-dir: site  # Assuming mkdocs build output is the default 'site' directory