docs(examples): add example and see also ref for Table.execute #6016
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: Docs PR | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| - "*.x.x" | |
| merge_group: | |
| concurrency: | |
| group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} | |
| cancel-in-progress: true | |
| permissions: | |
| # increase the rate limit for github operations, but limit token permissions | |
| # to read-only | |
| contents: read | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: install nix | |
| uses: cachix/install-nix-action@v30 | |
| with: | |
| extra_nix_config: | | |
| access-tokens = github.com=${{ secrets.GITHUB_TOKEN }} | |
| - name: setup cachix | |
| uses: cachix/cachix-action@v15 | |
| with: | |
| name: ibis | |
| authToken: ${{ secrets.CACHIX_AUTH_TOKEN }} | |
| extraPullNames: nix-community | |
| - name: checkout | |
| uses: actions/checkout@v4 | |
| - name: run doctests | |
| # keep HOME because duckdb (which we use for doctests) wants to use | |
| # that for extensions | |
| run: nix develop '.#ibis311' --ignore-environment --keep HOME --keep HYPOTHESIS_PROFILE -c just doctest | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: install nix | |
| uses: cachix/install-nix-action@v30 | |
| with: | |
| extra_nix_config: | | |
| access-tokens = github.com=${{ secrets.GITHUB_TOKEN }} | |
| - name: setup cachix | |
| uses: cachix/cachix-action@v15 | |
| with: | |
| name: ibis | |
| authToken: ${{ secrets.CACHIX_AUTH_TOKEN }} | |
| extraPullNames: nix-community | |
| - name: checkout | |
| uses: actions/checkout@v4 | |
| - name: restore cache of the previously rendered notebooks | |
| uses: actions/cache/restore@v4 | |
| with: | |
| key: docs-${{ github.event.pull_request.base.sha }} | |
| path: docs/**/.jupyter_cache | |
| - name: run quarto check | |
| run: nix develop '.#ibis311' --ignore-environment --keep HOME -c quarto check | |
| - name: generate api docs | |
| run: nix develop '.#ibis311' --ignore-environment -c just docs-apigen --verbose | |
| - name: build docs | |
| run: nix develop '.#ibis311' --ignore-environment --keep HOME -c just docs-render | |
| - name: build jupyterlite | |
| run: nix develop '.#ibis311' --ignore-environment --keep HOME -c just build-jupyterlite | |
| - name: check that all frozen computations were done before push | |
| run: git diff --exit-code --stat | |
| - name: verify internal links | |
| run: nix develop --ignore-environment '.#links' -c just checklinks --offline --no-progress |