Repository navigation
One launcher, fastsurfer, for containers and the macOS package; --exec, AMD GPUs, and docs #1831
Workflow file for this run
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: AUTO doc | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }} | |
| cancel-in-progress: true | |
| on: | |
| pull_request: | |
| push: | |
| branches: [dev, stable] | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| timeout-minutes: 15 | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v7 | |
| with: | |
| path: src | |
| # doc/conf.py refers to the newest release tag in the documentation of a development version | |
| fetch-tags: true | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: '3.12' | |
| - name: Install the documentation environment | |
| # The docs only import torch, so the CPU wheels suffice; --torch-backend exists only in the | |
| # uv pip interface, uv run --project would install the CUDA build. | |
| run: | | |
| uv venv .venv | |
| uv pip install --torch-backend cpu -e "./src[doc]" | |
| - name: Build doc | |
| env: | |
| PYTHONPATH: ${{ env.PYTHONPATH != '' && format( '{1}:src', env.PYTHONPATH ) || 'src' }} | |
| TZ: UTC | |
| run: | | |
| .venv/bin/sphinx-build -WT --keep-going -j auto src/doc doc-build | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: doc | |
| path: | | |
| doc-build | |
| !doc-build/.doctrees | |
| # deploy | |
| - name: Deploy the {dev,stable} documentation to github.io | |
| # only on push to dev or stable | |
| if: ${{ success() && github.event_name == 'push' && contains(fromJSON('["dev", "stable"]'), github.ref_name) }} | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: doc-build | |
| exclude_assets: '.doctrees' | |
| # destination_dir: github.ref_name will be dev or stable | |
| destination_dir: ${{ github.ref_name }} | |
| user_name: 'github-doc-action[bot]' | |
| user_email: 'github-doc-action[bot]@users.noreply.github.com' |