Intersphinx Registry

A simple utility package that provide default inter sphinx mapping for a large chunk of the python ecosystem.

Usage in conf.py

from intersphinx_registry import get_intersphinx_mapping

# ...
intersphinx_mapping = get_intersphinx_mapping(
    packages={"ipython", "matplotlib", "pandas", "python"}
)
intersphinx_mapping.update({
    'overwrite': ('<url>', None),
    'my-package' : ('<url>', None),
})

quick lookup

You can use the following to lookup target/webpages of various packages.

$ python -m intersphinx_registry.lookup ipython | grep whatsnew7
    whatsnew700                              IPython 7.0.0                           : whatsnew/version7.html#whatsnew700
    whatsnew710                              IPython 7.1.0                           : whatsnew/version7.html#whatsnew710
    whatsnew720                              IPython 7.2.0                           : whatsnew/version7.html#whatsnew720
    whatsnew730                              IPython 7.3.0                           : whatsnew/version7.html#whatsnew730
    whatsnew740                              IPython 7.4.0                           : whatsnew/version7.html#whatsnew740
    whatsnew750                              IPython 7.5.0                           : whatsnew/version7.html#whatsnew750
    whatsnew760                              IPython 7.6.0                           : whatsnew/version7.html#whatsnew760

Why ?

Sometime packages docs move and it's hard to keep track of. We try to keep the registry up to date, so yo do not have to ask yourself questions and update your intersphinx-mapping.

You also might not want to think about adding intersphinx mapping when you refer to dependencies.

A package url is wrong !

Please send a PR updating only this package in the registry.json. We try to link only to stable package, not dev versions.

A package is missing !

We can't do all packages, but if you think a package is widely used and missing, please send a PR.

Oven