The extension for Sphinx documentation projects that handle redirects for moved pages. It generates HTML pages with meta refresh redirects to the new page location to prevent 404 errors if you rename or move your documents.
Project description
sphinx-reredirects
The extension for Sphinx documentation projects that handle redirects for moved pages. It generates HTML pages with meta refresh redirects to the new page location to prevent 404 errors if you rename or move your documents.
The sphinx-reredirects started from the urge to manage redirects for all documents after moving our Tech writer at work blog to the new address at https://documatt.com/blog/.
Prevents 404 errors · Wildcard matching · Dynamic placeholders
Cross-domain redirects · Centralized configuration in conf.py
Easy to use · Works seamlessly with Sphinx
📚 Documentation · 📟 Source code
Good URLs are never changing URLs. But if you must, sphinx-reredirects helps you manage redirects with ease and from a single place in the project's conf.py.
For example, if you rename document start to intro, and tell it to sphinx-reredirects, it will generate the HTML page start.html with client-side redirect (requires no server-side configuration).
The extension supports wildcards and moving to different domains, too.
Community
Connect with other fellows who are building with Sphinx. Share knowledge, get help, and contribute to the open-source project. Check out our Documatt Community page to see featured material and upcoming events.
Join our community here:
- 🌟 Explore our GitHub
- 📥 Subscribe to our newsletter
- 🐦 Follow us on X
- 🕴️ Follow us on LinkedIn
- 📺 Subscribe to our YouTube channel
- 📚 Read our blog posts
Legal
sphinx-reredirects is MIT licensed.
Icon "route-alt-right" by TabletIcons.
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 sphinx_reredirects-1.0.0.tar.gz.
File metadata
- Download URL: sphinx_reredirects-1.0.0.tar.gz
- Upload date:
- Size: 712.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.32.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7c9bada9f1330489fcf4c7297a2d6da2a49ca4877d3f42d1388ae1de1019bf5c
|
|
| MD5 |
235c5f317ce69012d934b97decf64f3f
|
|
| BLAKE2b-256 |
7261d3039bc2b688c73e81f515afe771b7cc9631dfef63b3e3ac3aab3d73c685
|
File details
Details for the file sphinx_reredirects-1.0.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_reredirects-1.0.0-py3-none-any.whl
- Upload date:
- Size: 6.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.32.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1d0102710a8f633c6c885f940f440f7195ada675c1739976f0135790747dea06
|
|
| MD5 |
4138382460d926fc4abe87e0a98c3378
|
|
| BLAKE2b-256 |
2a7fadb886a3db417a2ccea6a13dcb4b88d08f82104aed17e347346f79480a5f
|
