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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for intersphinx_registry-0.2408.13.tar.gz
Algorithm Hash digest
SHA256 38a23a46e8a8c10583a730a6c54c35a244de2c24cc2d3ef320ead2b87be117cb
MD5 e9c414d2586e76f72cd2d3c0d459349e
BLAKE2b-256 229394ebb542ad34a3e1573b0c7df8dfba22015ba76a00266bbbca5d14eea5b0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for intersphinx_registry-0.2408.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 144b64633116905e35c1a2ad66244f41378762bf784074cfe5eee1845f4316d8
MD5 b66d9b791bdb0635965f6f3b4418b9bc
BLAKE2b-256 7d7669e705de54f6019730073c41da5c49e0e13fb4f43533fb5d45ccf1835d9a

See more details on using hashes here.

Provenance

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