add link to docs in README #2
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: Deploy odoc to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| permissions: read-all | |
| concurrency: | |
| group: deploy-odoc | |
| cancel-in-progress: true | |
| jobs: | |
| deploy-odoc: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| permissions: | |
| contents: read | |
| id-token: write | |
| pages: write | |
| steps: | |
| - name: Checkout (GitHub) | |
| uses: actions/checkout@v4 | |
| - name: Login to GitHub Container Registry | |
| uses: docker/login-action@v2 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.repository_owner }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Build documentation | |
| uses: devcontainers/ci@v0.3 | |
| with: | |
| cacheFrom: ghcr.io/mt-caret/polars-ocaml | |
| runCmd: | | |
| opam exec -- dune build @doc | |
| - name: Set-up Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: _build/default/_doc/_html | |
| - name: Deploy odoc to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v3 |