PySDM/.github/workflows/pdoc.yml at main · emmacware/PySDM · 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
name: pdoc

defaults:
  run:
    shell: bash

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
  schedule:
    - cron: '0 13 * * 4'

jobs:
  pdoc:
    strategy:
      matrix:
        platform: [ ubuntu-latest, macos-latest, windows-latest ]
    runs-on: ${{ matrix.platform }}
    steps:
      - uses: actions/checkout@v4.1.6
        with:
          submodules: recursive
          persist-credentials: false
      - uses: actions/setup-python@v5.0.0
        with:
          python-version: "3.12"

      - name: exclude pvpython scripts
        run: rm examples/PySDM_examples/utils/pvanim.py

      - run: pip install pdoc nbformat gitpython
      - run: pip install -e .
      - run: pip install -e examples
      - run: python -We docs/generate_html.py . .

      - if: ${{ github.ref == 'refs/heads/main' && matrix.platform == 'ubuntu-latest' }}
        uses: JamesIves/github-pages-deploy-action@4.1.1
        with:
          branch: pdoc
          folder: html
          clean: true