1
1
User-defined Redirects
2
2
======================
3
3
4
- You can set up redirects for a project on the project's Admin page.
4
+ You can set up redirects for a project in your project dashboard 's Redirects page.
5
5
6
+ Quick Summary
7
+ -------------
8
+
9
+ * Log into your Readthedocs.com Admin account.
10
+ * From your dashboard, select the project on which you wish to add redirects.
11
+ * From the project's top navigation bar, select the Admin tab.
12
+ * From the left navigation menu, select Redirects.
13
+ * In the form box "Redirect Type" select the type of redirect you want. See below for detail.
14
+ * Depending on the redirect type you select, enter FROM and/or TO URL as needed.
15
+ * When finished, click the SUBMIT Button.
16
+
17
+ Your redirects will be effective immediately.
18
+
19
+ Redirect Types
20
+ --------------
6
21
Prefix Redirects
7
- ----------------
22
+ ~~~~~~~~~~~~~~~~
8
23
9
24
The most useful and requested feature of redirects was when migrating to Read the Docs from an old host.
10
25
You would have your docs served at a previous URL,
@@ -30,7 +45,7 @@ Your users query would now redirect in the following manner::
30
45
Where ``en `` and ``latest `` are the default language and version values for your project.
31
46
32
47
Page Redirects
33
- --------------
48
+ ~~~~~~~~~~~~~~
34
49
35
50
A more specific case is when you move a page around in your docs.
36
51
The old page will start 404'ing,
@@ -48,7 +63,7 @@ Note that the ``/`` at the start doesn't count the ``/en/latest``,
48
63
but just the user-controlled section of the URL.
49
64
50
65
Exact Redirects
51
- ---------------
66
+ ~~~~~~~~~~~~~~~
52
67
53
68
If you're redirecting from an old host AND you aren't maintaining old paths for your
54
69
documents, a Prefix Redirect won't suffice and you'll need to create *Exact Redirects *
@@ -73,7 +88,7 @@ Note that you should insert the desired language for "en" and version for "lates
73
88
achieve the desired redirect.
74
89
75
90
Sphinx Redirects
76
- ----------------
91
+ ~~~~~~~~~~~~~~~~
77
92
78
93
We also support redirects for changing the type of documentation Sphinx is building.
79
94
If you switch between *HTMLDir * and *HTML *, your URL's will change.
@@ -90,3 +105,4 @@ This means that redirects will only happen in the case of a *404 File Not Found*
90
105
91
106
In the future we might implement redirect logic in Javascript,
92
107
but this first version is only implemented in the 404 handlers.
108
+
0 commit comments