intersphinx-registry

What it is and what it does

Intersphinx Registry is a utility that maintains a curated mapping of intersphinx targets for a large portion of the Python ecosystem. Instead of manually tracking and updating documentation URLs for each dependency in your Sphinx configuration, you can call a single function to retrieve pre-configured mappings for packages you actually use.

The package serves two main purposes: it simplifies Sphinx configuration by providing sensible defaults for common packages, and it offers command-line tools to look up documentation targets, reverse-lookup URLs to find their Sphinx references, and scan reStructuredText files to suggest intersphinx references as replacements for hardcoded URLs. It requires no runtime dependencies and installs cleanly.

Use it for:

• Automatically populate intersphinx_mapping in a Sphinx conf.py for projects that depend on popular packages like NumPy, SciPy, or Pandas
• Search across multiple package documentation inventories from the command line to find the correct intersphinx target for a symbol
• Convert hardcoded documentation URLs in existing .rst files into proper Sphinx cross-references
• Reverse-lookup a documentation URL to discover its corresponding Sphinx domain and target reference

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides a pre-built intersphinx mapping registry for common Python packages, eliminating the need to manually configure documentation cross-references in Sphinx projects.

Yes. The package has zero runtime dependencies, permissive licensing, active maintenance, and solves a real friction point in Sphinx configuration. Install the base package if you maintain Sphinx documentation; add the [cli] extra if you want command-line lookup tools.

Install

intersphinx-registry on PyPI

pip install intersphinx-registry

uv add intersphinx-registry

poetry add intersphinx-registry

Installing intersphinx-registry

Before you install

Low install friction with no runtime dependencies. Active maintenance, last release 50 days ago.

License in practice

MIT license permits unrestricted use, modification, and distribution with minimal restrictions.

Quickstart

pip install intersphinx_registry

In conf.py:
from intersphinx_registry import get_intersphinx_mapping
intersphinx_mapping = get_intersphinx_mapping(
    packages={"ipython", "matplotlib", "pandas", "python"}
)

Verify before relying

• Whether the registry covers all widely-used packages or only a subset of the ecosystem
• How frequently the registry is updated when package documentation URLs change
• Performance characteristics when querying large numbers of packages

Package facts

Evidence: intersphinx_registry-0.2606.25-py2.py3-none-any.whl

Tags

More Sphinx packages