cloud_sptheme.ext.auto_redirect – Redirect Deprecated URLs

New in version 1.9.

Overview

This extension is helpful for when html documentation has been relocated to a new host; e.g. moving from pythonhosted.org to readthedocs.io. Once enabled, it adds a helpful “Documentation has moved” message to the top of every page, and automatically redirects the user as well.

Configuration

This extension looks for the following config options:

auto_redirect_subject

subject to insert into message. defaults to The {project name} documentation.

auto_redirect_domain_url

url to redirect user to. no message or redirect will happen if this isn’t set.

auto_redirect_domain_footer

optional footer text to append to message

Internals

This should work with other sphinx themes, the js & css is (mostly) generic.

Todo

the “redirect to exact page” part of JS code currently only works with this theme; would like to fix that.

Todo

support configuring redirects to other pages within same documentation.

Todo

if user has dismissed “auto redirect”, remember via cookie?