reLabel is a tool for redirecting labels in your Sphinx documentation.
In documentation, we go to great lengths to redirect pages as they're moved, but we don't show the same care with Sphinx labels. If external documentation links to your project with Intersphinx, then removing labels will break references to them.
With reLabel, you can redirect removed labels to any existing label in your docs, preventing any surprise Intersphinx breakages.
Usage
Map removed labels to existing labels with the label_redirects option in your
conf.py file:
label_redirects = {
"old-label": "new-label"
}
Alternatively, list the label redirects in a separate file, formatted as valid JSON:
label_redirects = "labels.json"
Project setup
reLabel is published on PyPI and can be installed with:
pip install sphinx-relabel
After adding reLabel to your Python project, update your Sphinx's conf.py file to include reLabel as one of its extensions:
extensions = [
"sphinx_relabel"
]
Community and support
You can report any issues or bugs on the project's GitHub repository.
If you're interested in contributing to reLabel, start with the contribution guide.
License and copyright
reLabel is released under the GPL-3.0 license.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-relabel 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_relabel-0.0.4.tar.gz | 514.2 kB | With provenance | Details for sphinx_relabel-0.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_relabel-0.0.4-py3-none-any.whl | Python 3 | none | any | Details for sphinx_relabel-0.0.4-py3-none-any.whl |
Total release size: 531.3 kB
Release files / sphinx_relabel-0.0.4.tar.gz
| Download URL | sphinx_relabel-0.0.4.tar.gz |
|---|---|
| Size | 514.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bff188267885f0d44dee7e11b134abf7bb9344e13d59cb68441d2c83d9881157
|
|
BLAKE2b-256 checksum How to use checksums |
81419c0bd1efa4099863398290ab8b6d906ff765e71b94e0d8ab5085577f683c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 19, 2026.
Transparency logRelease files / sphinx_relabel-0.0.4-py3-none-any.whl
| Download URL | sphinx_relabel-0.0.4-py3-none-any.whl |
|---|---|
| Size | 17.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6c58913ca6df5fe36b5bc9b780d91c64ae3d2cf4acd234efb22a98fcbbe6d4bd
|
|
BLAKE2b-256 checksum How to use checksums |
28e92c5ca2340af1cf03c007419b473d5bba8f67f12af9633a6fa5062450742c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 19, 2026.
Transparency logSecurity for sphinx-relabel 0.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for sphinx_relabel-0.0.4.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 19, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
