Skip to content

Vendor Python 3.10 intersphinx inventory for pydabs docs #6897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sankalp-Mittal wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Vendor Python 3.10 intersphinx inventory for pydabs docs #6897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Vendor Python 3.10 intersphinx inventory for pydabs docs 
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>
  • Loading branch information
@Sankalp-Mittal Isaac
Sankalp-Mittal and Isaac committed Oct 1, 2026
commit c0b159b954f27427a35659f6843aa6e5fd49f343
Binary file added python/docs/_inventory/python-3.10.inv
View file
Open in desktop
Binary file not shown.
7 changes: 6 additions & 1 deletion python/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@

toc_object_entries = False

# Resolve stdlib cross-references against a vendored inventory instead of
# fetching docs.python.org/3.10/objects.inv at build time. The public URL is
# still used for the generated links; only the inventory is read locally, so a
# docs.python.org outage can't break the strict (-W) build. Python 3.10 is
# frozen, so the file never needs refreshing.
intersphinx_mapping = {
"python": ("https://docs.python.org/3.10", None),
"python": ("https://docs.python.org/3.10", "_inventory/python-3.10.inv"),
}
Loading