Skip to content

docs: build historical tags prose-only to fix deploy - #2616

Merged
TATP-233 merged 1 commit into
mainfrom
docs/fix-historical-autodoc
Nov 19, 2026
Merged

TATP-233 merged 1 commit into
mainfrom
docs/fix-historical-autodoc

Conversation

@LeeLeno

@LeeLeno LeeLeno commented Nov 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Keep the full autodoc API reference for main.
  • Build all historical tags prose-only by excluding api_reference/** and disabling autosummary.
  • Document the behavior and add a changelog entry.

Why

sphinx-multiversion switches the documentation source to historical tags, but the deploy environment still imports the currently installed unilab package. Historical API pages therefore import modules removed from current unilab and fail the deploy build (for example unilab.tasks.manipulation on v1.0.0). Generating those pages from the current package would also misdescribe historical APIs.

Validation

  • Full main multiversion build succeeds locally with the current package and API reference.
  • Historical tags no longer execute autodoc/autosummary imports, removing the failed path from run 44467841483.
  • CI will validate the PR prose-only build; merge will exercise the full multiversion deploy path.

Follow-up to #2584.

autodoc documents the installed package, which is always the checkout
being deployed. Generating the API reference for historical tags failed
the deploy build on removed modules (unilab.dr, tasks.locomotion.a2/go1/
go2_arm/go2w, tasks.manipulation) and would misdescribe the old API
anyway. Build tags prose-only; main keeps the full autodoc build.
@LeeLeno
LeeLeno requested a review from TATP-233 as a code owner November 19, 2026 09:26
@TATP-233
TATP-233 merged commit c9ed52a into main Nov 19, 2026
12 checks passed
@TATP-233
TATP-233 deleted the docs/fix-historical-autodoc branch November 19, 2026 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants