Skip to content

A one-liner sphinx build that does a readthedocs redirect.

Notifications You must be signed in to change notification settings

zzzeek/redirectthedocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Redirect The Docs

A Sphinx project that builds a simple redirect to the "canonical url" on readthedocs.

Since readthedocs has no ability to redirect to a new server, there's no way for any established project that used the readthedocs.io domain to ever move anywhere else without frustrated users.

Therefore, this project fixes that! Simply go to whatever readthedocs project you have which you'd like to redirect, point it at this github repo (or a fork you make yourself in case you're worried I'm going to change something! >:) ) then enter the desired base redirect into the "Domains" page, click the "canonical" checkbox and save. Then build! You're welcome.

What works

When people hit the root of your docs, it will redirect to the canonical URL.

What doesn't Work Yet

RTD doesn't yet allow us to set up a 404 page, but when they do, we can then work on getting all the other pages to redirect cleanly to the target URL.

About

A one-liner sphinx build that does a readthedocs redirect.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published