Skip to content

Quick Start

Quick Start #62

Workflow file for this run

---
name: build_test
on:
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install the latest version of uv
uses: astral-sh/setup-uv@v6
with:
version: "latest"
# https://github.com/astral-sh/setup-uv?tab=readme-ov-file#github-authentication-token
github-token: ${{ secrets.GITHUB_TOKEN }}
python-version: ${{ matrix.python-version }}
- name: Install MkDocs and dependencies
run: uv sync --no-dev
- name: Generate diff files
run: uv run --script docs/examples/preprocess.py
- name: Toggle skip error checks on generate_diffs.sh
run: ./docs/examples/toggle_skip_generate_diffs_err_check.sh
shell: bash
- name: Build MkDocs site
run: uv run mkdocs build --site-dir ./_build/html
- name: Save artifact to GitHub
uses: actions/upload-artifact@v4
with:
name: docs-build-test
path: ./_build/html