You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,16 +91,16 @@ Note that changes to examples must generally be in a release before they are ren
91
91
92
92
## Linking to new projects
93
93
94
-
ReadTheDocs should be configured to provide [redirects] that allow subprojects to be found at URLs like [docs.openforcefield.org/toolkit]. Redirects can be defined in the [Redirects tab] of the Admin page at [readthedocs.org]. For each project, two "exact" redirects should be defined:
94
+
ReadTheDocs should be configured to provide [redirects] that allow subprojects to be found at URLs like <https://docs.openforcefield.org/toolkit>. Redirects can be defined in the [Redirects tab] of the ReadTheDocs Admin page. For each project, two "exact" redirects should be defined:
95
95
96
-
1. From `/projectname/$rest` to the URL of the project's docs. This handles arbitrary links within the docs.
96
+
1. From `/projectname/*` to the URL of the project's docs. This handles arbitrary links within the docs.
97
97
2. From `/projectname` to the URL of the project's docs. This handles the bare project name without a trailing forward slash.
98
98
99
99
For projects hosted outside of ReadTheDocs, the "to" URL should be the URL of the hosted documentation:
100
100
101
101
> Redirect type: `Exact redirect`\
102
-
> From URL: `/standards/$rest`\
103
-
> To URL: `https://openforcefield.github.io/standards/`
102
+
> From URL: `/standards/*`\
103
+
> To URL: `https://openforcefield.github.io/standards/:splat`
104
104
105
105
> Redirect type: `Exact redirect`\
106
106
> From URL: `/standards`\
@@ -124,8 +124,6 @@ Then, redirects can be added to provide `docs.openforcefield.org/projectname`; t
124
124
You must have maintainer access to a project on RTD to add it as a subproject. If a project cannot be added as a subproject, the "to" URL can be set to the URL of the hosted documentation as with projects hosted externally.
0 commit comments