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.14.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

intersphinx_registry-0.2410.14-py2.py3-none-any.whl (6.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for intersphinx_registry-0.2410.14.tar.gz
Algorithm Hash digest
SHA256 f620e8390316c3eb199d40425d179426b1361cc86ce55118776ce028ac988250
MD5 0182b47bb1a6c4f60a149d709b6c1bee
BLAKE2b-256 14d72d19a73ea803596e1be0e178abe1588ad1926fb6c7f1519af02491b03ef3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for intersphinx_registry-0.2410.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7dba20cd57fd54b9003931d28b9eb4c4827cc8fdc0badaac1340b3dd1480b21b
MD5 7e3b7830a5efe9c20e1ca40dcc7dc63d
BLAKE2b-256 a57d8270e5e2bd7fcc30d660d1a29e754a6d24c5df2f258f5f87ef793e3874c4

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