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

Uploaded Source

Built Distribution

intersphinx_registry-0.0.3-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.3.tar.gz.

File metadata

  • Download URL: intersphinx_registry-0.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 038ae5547f2108324dbde54a70390c81dbabbe9d4e6631cbbfdf8f4c0d9b2103
MD5 46aef8a99f6058a164fe96bb5016a9cb
BLAKE2b-256 a8caaae213ade8a2ac4d99ce282ade1ae861d5420b9fd610be310c4f21416264

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for intersphinx_registry-0.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7b1ec202f16ad2296ce9a10d1a5e4b33e1e96faf71906223cbfbed1b45a7cf6e
MD5 62b12ede90bdfe5a9387aff0e9221515
BLAKE2b-256 aaedcc7f445d449e0d0a411f9b0ca6989eb8c9c0bd5795cb617d60d59397e8ca

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