Skip to content

CI: Set HF_TOKEN from runner env with secret fallback (#310) #155

CI: Set HF_TOKEN from runner env with secret fallback (#310)

CI: Set HF_TOKEN from runner env with secret fallback (#310) #155

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- main
- docs-website
pull_request:
branches:
- main
workflow_dispatch:
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Install ATOM (for autodoc)
run: |
pip install torch --index-url https://download.pytorch.org/whl/cpu
pip install -e . || true
- name: Build Sphinx documentation
run: |
cd docs
make html
- name: Upload documentation artifacts
uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/_build/html/
retention-days: 7
deploy-docs:
needs: build-docs
runs-on: ubuntu-latest
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs-website')
permissions:
contents: write
steps:
- name: Download documentation artifacts
uses: actions/download-artifact@v4
with:
name: documentation
path: ./html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./html
commit_message: 'docs: deploy documentation'