fix(sphinxdocs): add retry logic when exit code 2 occurs#3241
Merged
rickeylev merged 2 commits intobazel-contrib:mainfrom Sep 6, 2025
Merged
fix(sphinxdocs): add retry logic when exit code 2 occurs#3241rickeylev merged 2 commits intobazel-contrib:mainfrom
rickeylev merged 2 commits intobazel-contrib:mainfrom
Conversation
Running Sphinx multiple times in the same process sometimes results
in an error ("exit code 2"). Digging in, this is likely a bug in
the sphinx_bzl plugin in how it merges data when parallel or incremental
builds are performed.
Until that's fixed, work around the problem by internally retrying
the Sphinx build when exit code 2 occurs. This is basically what we're
doing today and should reduce the number of flakes for the RTD builds.
aignas
approved these changes
Sep 5, 2025
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
2 participants
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.
Running Sphinx multiple times in the same process sometimes results in an error ("exit code 2"). Digging in, this is likely a bug in the sphinx_bzl plugin in how it merges data when parallel or incremental builds are performed.
Until that's fixed, work around the problem by internally retrying the Sphinx build when exit code 2 occurs. This is basically what we're doing today and should reduce the number of flakes for the RTD builds.
Along the way, improve the error reporting to make it easier to diagnose the underlying failure.