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

Uploaded Source

Built Distribution

intersphinx_registry-0.0.2-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for intersphinx_registry-0.0.2.tar.gz
Algorithm Hash digest
SHA256 5aaeec1e9f5a37877d70e0ed71e13294bde84d318604e96e0951f319bff1dc6e
MD5 4853461b29b4ef12dd7d18a4ab90eb62
BLAKE2b-256 1f1c57113a3fe20a16f3e9f8b5894cdb55f1fcbddff89c6cb3393095e8842360

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for intersphinx_registry-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0aee590e87f586cd60193b48f67943128d2559d729efc4590f170cecf738a723
MD5 fc69b4bddf7e7882a3c2e5abfabd4a57
BLAKE2b-256 b791ebf5fc586ecf2c852e1b6f61176090e6d1d5d47325eacba18e825a5ee254

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