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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file intersphinx_registry-0.2410.1.tar.gz.
File metadata
- Download URL: intersphinx_registry-0.2410.1.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e03931736e59d83446bd1aa0f04df8f1e124b1a805441ddcd75dba9151926371 |
|
| MD5 | 1b15fec62005b9764c7d22f70573d7ce |
|
| BLAKE2b-256 | c14bf3809463fb1f412957541dedde81443eceb30f327cf08dc7659db9d596b3 |
Provenance
File details
Details for the file intersphinx_registry-0.2410.1-py2.py3-none-any.whl.
File metadata
- Download URL: intersphinx_registry-0.2410.1-py2.py3-none-any.whl
- Upload date:
- Size: 6.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5dd8451d0b757a1e1477916dfb35d74db60faf2a47aaac5ab1a54916b23b5736 |
|
| MD5 | f3967d629fd5a616539da27bf25e6141 |
|
| BLAKE2b-256 | eea6b0ece960edb6a5282ecd5a4c0957c2d79aab57b8f2f76b59d22902a239b8 |
