docs #1
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: docs | |
| on: | |
| workflow_run: | |
| workflows: [CI] | |
| types: | |
| - completed | |
| branches: | |
| - main | |
| env: | |
| UV_FROZEN: true | |
| jobs: | |
| # Build the documentation and upload the static HTML files as an artifact. | |
| build: | |
| if: ${{ github.event.workflow_run.conclusion == 'success' }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| pyproject-file: pyproject.toml | |
| - name: Install the project | |
| run: uv sync --all-extras | |
| - name: Build docs | |
| run: uv run pdoc -o docs/ -d google bids2table | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/ | |
| # Deploy the artifact to GitHub pages. | |
| # This is a separate job so that only actions/deploy-pages has the necessary permissions. | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v4 |