Skip to content

Commit c27583b

Browse files
Update README.md
1 parent bddfeaf commit c27583b

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,16 +91,16 @@ Note that changes to examples must generally be in a release before they are ren
9191

9292
## Linking to new projects
9393

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:
9595

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.
9797
2. From `/projectname` to the URL of the project's docs. This handles the bare project name without a trailing forward slash.
9898

9999
For projects hosted outside of ReadTheDocs, the "to" URL should be the URL of the hosted documentation:
100100

101101
> 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`
104104
105105
> Redirect type: `Exact redirect` \
106106
> From URL: `/standards` \
@@ -124,8 +124,6 @@ Then, redirects can be added to provide `docs.openforcefield.org/projectname`; t
124124
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.
125125

126126
[docs.openforcefield.org]: https://docs.openforcefield.org/
127-
[redirects]: https://docs.readthedocs.io/page/user-defined-redirects.html
128-
[docs.openforcefield.org/toolkit]: https://docs.openforcefield.org/toolkit/
129-
[readthedocs.org]: https://readthedocs.org/
127+
[redirects]: https://docs.readthedocs.com/platform/stable/user-defined-redirects.html#user-defined-redirects
130128
[Redirects tab]: https://readthedocs.org/dashboard/openff-docs/redirects/
131129
[added as a subproject]: https://readthedocs.org/dashboard/openff-docs/subprojects/

0 commit comments

Comments
 (0)