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()
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 an 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.0.4.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

intersphinx_registry-0.0.4-py2.py3-none-any.whl (5.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: intersphinx_registry-0.0.4.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for intersphinx_registry-0.0.4.tar.gz
Algorithm Hash digest
SHA256 3469deefa0510f0a01b23c372588da224640476ae53228eb1d584de82ad4c58c
MD5 1018380de124365b222463fb7e6bf6c9
BLAKE2b-256 ff031099c1b8f9d9d60ec58ffcc919666292a6fcbbf8043c29e2230cfed82199

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for intersphinx_registry-0.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f7e2b11cead1588fb6c41e0ce698fe3abeff9defc10356ca0743ca026902dd4d
MD5 63a824728df80f28afb146e0314ce6a7
BLAKE2b-256 5b1426d5cf515923c0ef6713e4df061cabe9faefcf217073d136dacf6ee9a004

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