Repository navigation
docs: build historical tags prose-only to fix deploy - #2616
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
main.api_reference/**and disabling autosummary.Why
sphinx-multiversionswitches the documentation source to historical tags, but the deploy environment still imports the currently installedunilabpackage. Historical API pages therefore import modules removed from currentunilaband fail the deploy build (for exampleunilab.tasks.manipulationonv1.0.0). Generating those pages from the current package would also misdescribe historical APIs.Validation
mainmultiversion build succeeds locally with the current package and API reference.Follow-up to #2584.