[Unitary hack] Improve Docstrings in "task/batch" #2356
Workflow file for this run
This file contains 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(preview) | |
| on: | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - closed | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| # See: https://github.com/pdm-project/pdm/issues/1879 | |
| env: | |
| PDM_DEPS: 'urllib3<2' | |
| jobs: | |
| documentation: | |
| name: Deploy preview documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Wait for dev documentation to deploy | |
| uses: lewagon/wait-on-check-action@v1.3.4 | |
| with: | |
| ref: main | |
| check-name: 'Deploy dev documentation' | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| wait-interval: 10 | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.12 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - uses: pdm-project/setup-pdm@v4 | |
| name: Setup PDM | |
| with: | |
| python-version: 3.12 | |
| - name: Install dependencies | |
| run: pdm install -G doc | |
| - name: Set up build cache | |
| uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| key: mkdocs-material-${{ github.ref }} | |
| path: .cache | |
| restore-keys: | | |
| mkdocs-material- | |
| - name: Depoly documentation | |
| env: | |
| GH_TOKEN: ${{ secrets.GH_TOKEN }} | |
| GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }} | |
| run: | | |
| pdm run doc_build | |
| - name: Deploy preview | |
| uses: rossjrw/pr-preview-action@v1 | |
| with: | |
| source-dir: ./site |