Vendor Python 3.10 intersphinx inventory for pydabs docs - #6897
Open
Sankalp-Mittal wants to merge 1 commit into
Open
Sankalp-Mittal wants to merge 1 commit into
Sankalp-Mittal wants to merge 1 commit into
Conversation
The pydabs docs build (python/Taskfile.yml) resolves stdlib cross-references via intersphinx, which fetched docs.python.org/3.10/objects.inv over the network on every build. When docs.python.org returns 503, the inventory fails to load, the stdlib references go unresolved, and --nitpicky + -W turn that into a hard build failure. Vendor the inventory locally and point intersphinx at the committed file. The public URL is still used for the generated links; only the inventory is read from disk, so a docs.python.org outage can no longer break the build. Python 3.10 is frozen, so the file never needs refreshing. Verified: strict build (--nitpicky -W) succeeds with zero warnings, and still succeeds with outbound HTTPS blocked. Co-authored-by: Isaac <no-reply@databricks.com>
Collaborator
Integration test reportCommit: c0b159b
Top 6 slowest tests (at least 2 minutes):
|
This branch has not been deployed
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.
Problem
The pydabs docs build (
python/Taskfile.ymlpydabs-docs) resolves stdlib cross-references via Sphinx intersphinx, which fetchedhttps://docs.python.org/3.10/objects.invover the network on every build. When docs.python.org returns 503 (as it did this morning — see internal report), the inventory fails to load, the stdlib references (collections.abc.Callable,types.ModuleType) go unresolved, and--nitpicky+-Wturn those warnings into a hard build failure.Note the 503 trips
-Won its own even without--nitpicky: intersphinx logs its own "failed to reach any of the inventories" warning independent of nitpick mode, so fixing the gate flags wouldn't address the root cause — the build's network dependency on docs.python.org.Fix
Vendor the inventory locally (
python/docs/_inventory/python-3.10.inv) and point intersphinx at the committed file:The public URL is still used to build the output links; only the inventory is read from disk, so a docs.python.org outage can no longer break the build. Python 3.10 is frozen, so the file never needs refreshing. This keeps the strict
-Wgate and the stdlib hyperlinks intact while removing the flaky network dependency.Verification
sphinx-build docs docs/_output --nitpicky --fresh-env --keep-going -Wsucceeds with zero warnings.loading intersphinx inventory 'python' from _inventory/python-3.10.inv(local, not network).This pull request and its description were written by Isaac.