Add bias-aware calibration error estimators and an evaluation notebook #59
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 | |
| # Deliberate deviation from the py-canon docs shim. The canon reusable workflow | |
| # expects `docs/` as the Sphinx root with a `docs/conf.py` built from | |
| # `py_canon.sphinx.configure`, but this repo's documentation lives in | |
| # `docs/source/` and needs `nbsphinx` to render four tutorial notebooks, which the | |
| # canon config does not enable. Adopting the shim as-is would silently stop | |
| # publishing the notebooks. | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: docs-${{ github.ref }} | |
| cancel-in-progress: false | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0 | |
| with: | |
| python-version: "3.12" | |
| - name: Install pandoc (nbsphinx renders notebooks through it) | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y pandoc | |
| - name: Install dependencies | |
| run: uv sync --all-extras --all-groups | |
| - name: Build documentation | |
| run: uv run sphinx-build -b html --keep-going -E docs/source docs/_build/html | |
| - name: Setup Pages | |
| uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 | |
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | |
| - name: Upload documentation artifact | |
| uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 | |
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | |
| with: | |
| path: ./docs/_build/html | |
| - name: Deploy to GitHub Pages | |
| uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5 | |
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' |