Skip to content

chore: fix docs building (#19) #9

chore: fix docs building (#19)

chore: fix docs building (#19) #9

Workflow file for this run

name: Build and publish docs
on:
workflow_dispatch:
push:
branches:
- main
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run
# in-progress and latest queued.
concurrency:
group: "pages"
cancel-in-progress: true
env:
UV_VERSION: "0.4.29"
jobs:
build:
name: Build docs.
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up uv
uses: astral-sh/setup-uv@v3
with:
version: ${{ env.UV_VERSION }}
enable-cache: true
- name: Install Protoc
uses: arduino/setup-protoc@v2
- name: Build docs
run: uv run --group docs scripts/build_py_docs.sh
- name: Upload artifact.
uses: actions/upload-pages-artifact@v3
with:
path: ./python/docs/build/
publish:
name: Publish docs.
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Deploy to GitHub Pages.
id: deployment
uses: actions/deploy-pages@v4