modelcontextprotocol/python-sdk
Watch
1
0
Fork
You've already forked python-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[v1.x] ci: pick the docs toolchain per worktree in build-docs.sh (#3082)

Browse source
This commit is contained in:
Max 2026-07-25 20:37:13 +01:00 • committed by GitHub
commit c0c5a9d642
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 29 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

36
scripts/build-docs.sh
View file

@ -1,13 +1,17 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# #
# Build combined v1 + v2 MkDocs documentation for GitHub Pages. # Build combined v1 + v2 documentation for GitHub Pages.
# #
# v1 docs (from the v1.x branch) are placed at the site root. # v1 docs (from the v1.x branch) are placed at the site root.
# v2 docs (from main) are placed under /v2/. # v2 docs (from main) are placed under /v2/.
# #
# Both branches are fetched fresh from origin, so the output is identical # The two lines use different toolchains: v1.x still builds with MkDocs, while
# regardless of which branch triggered the workflow. This script is intended # main builds with Zensical (which needs a pre-build step to materialise the API
# to run in CI; for local single-branch preview use `uv run mkdocs serve`. # reference and a post-build step for llms.txt — see scripts/docs/). Each branch
# is fetched fresh from origin and built with its own synced `docs` group, so
# the output is identical regardless of which branch triggered the workflow.
# This script is intended to run in CI; for a local v2 preview use
# `scripts/serve-docs.sh`.
# #
# Usage: # Usage:
# scripts/build-docs.sh [output-dir] # scripts/build-docs.sh [output-dir]
@ -30,7 +34,21 @@ cleanup() {
} }
trap cleanup EXIT trap cleanup EXIT
rm -rf "${OUTPUT_DIR:?}"/* # Build the checked-out worktree into its local `site/`, picking the toolchain
# from the branch's own files rather than hard-coding it here: a branch that
# ships the Zensical build recipe (scripts/docs/build.sh) builds with it,
# otherwise it falls back to MkDocs. This keeps the combined build correct
# regardless of which branch triggered it. Zensical requires site_dir to live
# within the project root, so both paths build to the local `site/` and let
# the caller copy it to its destination.
build_site() {
if [[ -f scripts/docs/build.sh ]]; then
bash scripts/docs/build.sh
else
uv sync --frozen --group docs
NO_MKDOCS_2_WARNING=1 uv run --frozen --no-sync mkdocs build --site-dir site
fi
}
build_branch() { build_branch() {
local branch="$1" worktree="$2" dest="$3" local branch="$1" worktree="$2" dest="$3"
@ -43,11 +61,15 @@ build_branch() {
( (
cd "$worktree" cd "$worktree"
uv sync --frozen --group docs rm -rf site
uv run --frozen --no-sync mkdocs build --site-dir "$dest" build_site
mkdir -p "$dest"
cp -a site/. "$dest/"
) )
} }
rm -rf "${OUTPUT_DIR:?}"/*
build_branch v1.x "$V1_WORKTREE" "$OUTPUT_DIR" build_branch v1.x "$V1_WORKTREE" "$OUTPUT_DIR"
build_branch main "$V2_WORKTREE" "$OUTPUT_DIR/v2" build_branch main "$V2_WORKTREE" "$OUTPUT_DIR/v2"