Update cellPACK installation source #12
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| documentation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v3 | |
| with: | |
| version: "latest" | |
| - name: Cache environment | |
| id: cached-dependencies | |
| uses: actions/cache@v4 | |
| env: | |
| CACHE_NUMBER: 0 # Increment this number if you wish to hard-refresh the cache. | |
| with: | |
| path: .venv | |
| key: ${{ runner.os }}-${{ hashFiles('**/uv.lock') }}-${{ env.CACHE_NUMBER }} | |
| - name: Install dependencies | |
| if: steps.cached-dependencies.outputs.cache-hit != 'true' | |
| shell: bash -l {0} | |
| run: | | |
| uv sync | |
| - name: Generate documentation with Sphinx | |
| shell: bash -l {0} | |
| run: | | |
| uv run make docs | |
| touch docs/_build/html/.nojekyll | |
| - name: Publish docs | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: docs/_build/html | |
| clean-exclude: | | |
| _badges | |
| _coverage | |
| - name: Generate style badge | |
| uses: knightdave/anybadge-action@v1.1.0 | |
| with: | |
| file: docs/_badges/style.svg | |
| label: code style | |
| value: black | |
| color: black | |
| template: docs/_badges/template.svg | |
| overwrite: true | |
| - name: Generate passing badge | |
| if: success() | |
| uses: knightdave/anybadge-action@v1.1.0 | |
| with: | |
| file: docs/_badges/documentation.svg | |
| label: docs | |
| value: passing | |
| color: green | |
| template: docs/_badges/template.svg | |
| overwrite: true | |
| - name: Generate failing badge | |
| if: failure() | |
| uses: knightdave/anybadge-action@v1.1.0 | |
| with: | |
| file: docs/_badges/documentation.svg | |
| label: docs | |
| value: failing | |
| color: red | |
| template: docs/_badges/template.svg | |
| overwrite: true | |
| - name: Publish badge | |
| if: success() || failure() | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: docs/_badges | |
| target-folder: _badges | |
| clean: false |