Skip to content
Docs

Update docs #17

Sign in to view logs

Update docs

Update docs #17

Workflow file for this run

.github/workflows/docs.yml at 5af1497
name: "Docs"
on:
workflow_dispatch:
pull_request:
paths-ignore:
- "tests/**"
- "third_party/**"
- "*.md"
branches:
- main
push:
paths-ignore:
- "tests/**"
- "third_party/**"
- "*.md"
branches:
- main
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
strategy:
fail-fast: false
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- uses: conda-incubator/setup-miniconda@v3
with:
python-version: "3.12"
conda-remove-defaults: "true"
- name: Build docs
run: |
set -x
wget -qO- https://astral.sh/uv/install.sh | sh
uv pip install . -v
sudo apt update && sudo apt install -yqq doxygen
conda install -c conda-forge 'ffmpeg==6'
pip install -r docs/requirements.txt
pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
./docs/build.sh
mkdir upload
mv docs/_build upload/_site
- uses: actions/upload-artifact@v4
with:
name: docs
path: upload
if-no-files-found: error
retention-days: 7
overwrite: true
deploy:
permissions:
# Required for `git push`
# Note:
# This is not effective from fork.
# When you debug this, make sure to make a branch on the upstream, and
# make PR from there.
contents: write
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main'
steps:
- uses: actions/checkout@v3
with:
ref: gh-pages
fetch-depth: 5
- uses: actions/download-artifact@v4
with:
name: docs
- name: Update main doc
run: |
set -x
ls -alh
rm -rf main
mv _site main
git add --all main || true
git config user.name "ci"
git config user.email "[email protected]"
git commit --amend -m "Update docs" || true
git push -f