Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

name: docs

on:
pull_request:
types: [opened, synchronize, reopened]
paths:
- "docs/**"
- "pyproject.toml"
- "uv.lock"
- ".github/workflows/docs.yaml"

permissions:
contents: read

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Install uv
uses: astral-sh/setup-uv@v4

- name: Install doc dependencies
run: uv sync --group docs

- name: Build docs (strict)
run: uv run --group docs sphinx-build -W -b html docs docs/_build/html
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: check lint format lint-ts lint-py format-ts format-py docs docs-live docs-clean
.PHONY: check lint format lint-ts lint-py format-ts format-py docs docs-strict docs-live docs-clean
Comment thread
miyoungc marked this conversation as resolved.

check: lint-ts lint-py
@echo "All checks passed."
Expand All @@ -24,6 +24,9 @@ format-py:
docs:
uv run --group docs sphinx-build -b html docs docs/_build/html

docs-strict:
uv run --group docs sphinx-build -W -b html docs docs/_build/html

docs-live:
uv run --group docs sphinx-autobuild docs docs/_build/html --open-browser

Expand Down
Loading