intersphinx-registry

0.2605.27 verified Mon Apr 27 auth: no python

Provides utilities and mapping data for Sphinx intersphinx inventory URLs, enabling cross-referencing across documentation of popular Python libraries. Version 0.2605.27 has a release-per-commit cadence.

pip install intersphinx-registry

Common errors

error AttributeError: module 'intersphinx_registry' has no attribute 'get_intersphinx_mapping' ↓

cause Installed a very old version of intersphinx-registry that did not have this function.

fix

Upgrade: pip install --upgrade intersphinx-registry

error KeyError: 'numpy' ↓

cause Using a package name not in the registry.

fix

Check the list of supported packages: from intersphinx_registry import get_intersphinx_mapping; print(get_intersphinx_mapping().__len__()) or inspect the JSON file.

Warnings

gotcha Package names in get_intersphinx_mapping must match exactly the keys in the internal registry (e.g., 'python', 'numpy'). Abbreviated or incorrect names will silently return an empty mapping. ↓

fix Check the registry source for supported names: https://github.com/jarrodmillman/intersphinx-registry/blob/main/src/intersphinx_registry/data/objects.json

breaking Version 0.2605 introduced a new JSON-based data source. Older versions used a different format. If you were using intersphinx_registry before this version, your mappings may break or change. ↓

fix Upgrade to >=0.2605.27 and verify your intersphinx mappings.

deprecated The function get_intersphinx_mapping() returns a dict now, not a list of tuples. Some users may rely on the old format. ↓

fix Use dict items directly; no need to convert.

Imports

get_intersphinx_mapping

from intersphinx_registry import get_intersphinx_mapping

Quickstart

Get intersphinx mapping for common packages.

from intersphinx_registry import get_intersphinx_mapping

mapping = get_intersphinx_mapping(
    packages=['python', 'numpy', 'scipy', 'matplotlib']
)
# Use mapping in Sphinx conf.py:
# intersphinx_mapping = mapping