sphinxcontrib-redirects
This contrib extension, sphinxcontrib.redirects, provides a Sphinx extension for generating JavaScript-driven redirects for moved pages. It currently only supports the html builder (sphinx.builders.html.SingleFileHTMLBuilder).
Usage
To enable the extension, you should add it to your conf.py file:
extensions = [
'sphinxcontrib.redirects',
...
]
The extension relies on a redirect file. This defaults to redirects within the source directory but it can be overridden. To override this value, add the following to your conf.py file:
redirects_file = '<path to redirects file>'
The redirect file is a simple space-separated file of old_path - new_path pairs. These paths are relative to the source directory and should include their extension. For example, if you renamed the file test.rst to testing.rst then you could write:
test.rst testing.rst
This works for files moved between directories too. If you moved a test.rst to testing/index.rst instead, then you could write:
test.rst testing/index.rst
For examples, refer to the samples used in the tests.
Contributing
For information on contributing, refer to the contributing guide.
Metadata
Release files for sphinxcontrib-redirects 0.2.0
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 |
|---|---|---|---|---|
| sphinxcontrib_redirects-0.2.0.tar.gz | 7.3 kB | Without provenance | Details for sphinxcontrib_redirects-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinxcontrib_redirects-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for sphinxcontrib_redirects-0.2.0-py3-none-any.whl |
Total release size: 12.9 kB
Release files / sphinxcontrib_redirects-0.2.0.tar.gz
| Download URL | sphinxcontrib_redirects-0.2.0.tar.gz |
|---|---|
| Size | 7.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
51d407865c296a1b076a63f62be8a5e88ecf70a96cad6f8240814fdafd30c4b9
|
|
BLAKE2b-256 checksum How to use checksums |
4f357a00e96f18b4037e7d4e7678e612feda6e1670de9c0f510f13e81ff39fb2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / sphinxcontrib_redirects-0.2.0-py3-none-any.whl
| Download URL | sphinxcontrib_redirects-0.2.0-py3-none-any.whl |
|---|---|
| Size | 5.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7b831d29d9f58c97d3050a3e98d1cf56aa87a4e7bfded01fe83e1caf4c32cf5a
|
|
BLAKE2b-256 checksum How to use checksums |
a4a804cd4501d5da44a4acf55d9a54d034b08953e42d7f2b1a38bd73057ced5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Security for sphinxcontrib-redirects 0.2.0
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.
