Skip to main content

This package provides convenient utilities and data to write a sphinx config file.

Project description

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),
})

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

intersphinx_registry-0.2410.4.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

intersphinx_registry-0.2410.4-py2.py3-none-any.whl (6.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file intersphinx_registry-0.2410.4.tar.gz.

File metadata

File hashes

Hashes for intersphinx_registry-0.2410.4.tar.gz
Algorithm Hash digest
SHA256 4582e6d945e6cd249e7d145ff40c0b27534aec1dcb1b3722de518498f3bf4ea9
MD5 6e7e090f59888374e3a902f9d03ce99d
BLAKE2b-256 a66443b603db0eb22c5cead4f10abc0b0f025dfd4702710c4bf21f49c9ce40f0

See more details on using hashes here.

File details

Details for the file intersphinx_registry-0.2410.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for intersphinx_registry-0.2410.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 df0088931c7ba6d0fe617304cc741445791ee41d710fb43370b80170545f5a41
MD5 acb57cad9a98dee2c83f13811c5c9e48
BLAKE2b-256 7bddecb805875a764f95b4eb57c7da76da34cd890d89afd2ba5b46fd2e10b0f1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page