ANN: sphinx-reredirects extension for managing redirects

27 views
Skip to first unread message

Matt from Documatt

unread,
Sep 9, 2020, 11:06:56 AM9/9/20
to sphinx...@googlegroups.com
Hi, all dear Sphinx fellows!
Just a short off-topic. I want to share with you my simple extension. I called it "reredirects", the homepage is https://gitlab.com/documatt/sphinx-reredirects.

If you host documentation on static file hosting where server-side redirects are not possible, you may find this extension useful.

Copy&paste from its readme:

sphinx-reredirects is the extension for Sphinx documentation projects that handles redirects for moved pages. Based on its configuration, the extension generates HTML pages with meta refresh redirects to the new page location to prevent 404 errors if you rename or move your documents.

Good URLs are never changing URLs. But if you must, sphinx-reredirects helps you manage redirects with ease and from the single place in project's conf.py. For example, if you rename the document start to intro, you configure this redirect, the extension generates HTML page start.html with <meta http-equiv="refresh" content="0; url=intro.html">. sphinx-reredirects supports wildcards and moving to different domain too.

--
Matt
https://techwriter.documatt.com

Daniel Scott

unread,
Nov 25, 2020, 10:32:32 PM11/25/20
to sphinx...@googlegroups.com
--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAOGNDW-cm%2BPoLbTZF5Y3UKxigXGUx8c6gJGTSiV7%3DJuM3DzCdA%40mail.gmail.com.
Reply all
Reply to author
Forward
0 new messages