Repository navigation
Add Kit-less OVRTX rendering with Newton and OvPhysX backends #37
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
| # Build the COMPASS docs site (academic landing + Sphinx handbook) and deploy | |
| # it to GitHub Pages. | |
| # | |
| # Triggers: | |
| # - pull_request touching docs/ or this workflow -> build only (validates | |
| # `make html` -W and uploads the rendered _site/ as an artifact reviewers | |
| # can download from the run page). | |
| # - push to main touching docs/ or this workflow -> build + deploy. | |
| # - workflow_dispatch -> build + deploy on demand (any branch). | |
| # | |
| # Repo settings -> Pages -> Source must be "GitHub Actions" (not "Deploy from | |
| # a branch") for this to take over from the legacy gh_page branch. | |
| name: Build and deploy docs | |
| on: | |
| pull_request: | |
| paths: | |
| - "docs/**" | |
| - ".github/workflows/docs.yml" | |
| push: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| - ".github/workflows/docs.yml" | |
| workflow_dispatch: {} | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repo | |
| uses: actions/checkout@v4 | |
| with: | |
| # The Bulma project page lives under docs/project_page/ with a | |
| # handful of LFS-tracked images and videos. Pull them so they | |
| # actually appear in the deployed site. | |
| lfs: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install Sphinx + nvidia-sphinx-theme + extensions | |
| working-directory: docs/handbook | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Build handbook (warnings -> errors) | |
| working-directory: docs/handbook | |
| run: make html | |
| - name: Stage academic landing + handbook under _site/ | |
| run: | | |
| mkdir -p _site | |
| cp -r docs/project_page/. _site/ | |
| cp -r docs/handbook/_build/html _site/docs | |
| - name: Configure Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload site artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: _site | |
| deploy: | |
| # Only deploy on push to main or manual dispatch; PR builds stop after | |
| # the artifact upload above so the PR check validates the build without | |
| # touching the live Pages site. | |
| if: github.event_name != 'pull_request' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| steps: | |
| - name: Deploy to Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |