docs: add python notebook #42
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: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - docs/** | |
| - mkdocs.yml | |
| - python/** | |
| pull_request: | |
| paths: | |
| - docs/** | |
| - mkdocs.yml | |
| - python/** | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - uses: Swatinem/rust-cache@v2 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - uses: astral-sh/setup-uv@v3 | |
| with: | |
| enable-cache: true | |
| - name: Install dev requirements | |
| run: uv sync --extra docs | |
| - name: Install stacrs | |
| run: uv sync --no-dev --inexact --directory python | |
| - name: Build docs | |
| run: uv run mkdocs build --strict | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'site' | |
| deploy: | |
| environment: | |
| name: "github-pages" | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| if: success() && startsWith(github.ref, 'refs/heads/main') | |
| needs: | |
| - build | |
| steps: | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - uses: actions/download-artifact@v4 | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |