Better URLs for pip as example project.

Old URLs made more sense in original text that used astropy as example.
refactor-builder
Tom Offermann 2013-12-09 12:03:57 -08:00
parent 1f4b1db8b9
commit a252aa17e8
1 changed files with 2 additions and 2 deletions

View File

@ -17,9 +17,9 @@ For example::
pip.readthedocs.org -> pip.readthedocs.org/en/latest/
www.pip-installer.org -> www.pip-installer.org/en/latest
This only works for the root url, not for internal pages. It's designed to redirect people from http://pip.readthedocs.org/ to the default version of your documentation, since serving up a 404 here would be a pretty terrible user experience. (If your "latest" branch was designated as your default version, then it would redirect to http://pip.readthedocs.org/en/latest.) But, it's not a universal redirecting solution. So, as you've already noticed, a link to an internal page like http://pip.readthedocs.org/constants/ doesn't redirect to http://pip.readthedocs.org/en/latest/constants/.
This only works for the root url, not for internal pages. It's designed to redirect people from http://pip.readthedocs.org/ to the default version of your documentation, since serving up a 404 here would be a pretty terrible user experience. (If your "develop" branch was designated as your default version, then it would redirect to http://pip.readthedocs.org/en/develop.) But, it's not a universal redirecting solution. So, as you've already noticed, a link to an internal page like http://pip.readthedocs.org/usage.html doesn't redirect to http://pip.readthedocs.org/en/latest/usage.html.
The reasoning behind this is that RTD organizes the URLs for docs so that multiple translations and multiple versions of your docs can be organized logically and consistently for all projects that RTD hosts. For the way that RTD views docs, http://pip.readthedocs.org/en/stable/ is the root directory for your stable documentation in English, not http://pip.readthedocs.org/. Just like http://pip.readthedocs.org/en/latest/ is the root for your development documentation in English (taken from the "master" branch in git, which you've designated as the "latest" version in RTD.)
The reasoning behind this is that RTD organizes the URLs for docs so that multiple translations and multiple versions of your docs can be organized logically and consistently for all projects that RTD hosts. For the way that RTD views docs, http://pip.readthedocs.org/en/latest/ is the root directory for your default documentation in English, not http://pip.readthedocs.org/. Just like http://pip.readthedocs.org/en/develop/ is the root for your development documentation in English.
Among all the multiple versions of docs, you can choose which is the "default" version for RTD to display, which usually corresponds to the git branch of the most recent official release from your project.