The sphinx-reredirects is 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
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 <meta http-equiv="refresh" content="0; url=intro.html">.
The extension supports wildcards and moving to different domains, too.
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
sphinx-reredirects MIT licensed.
Icon "route-alt-right" by TabletIcons.