Skip to content

Commit 58dec9f

Browse files
committed
Docs: fix more external links
1 parent 0d8758c commit 58dec9f

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

docs/user/automatic-redirects.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ For example::
2727
docs.readthedocs.io -> docs.readthedocs.io/en/latest/
2828
www.pip-installer.org -> www.pip-installer.org/en/latest/
2929

30-
This only works for the root URL, not for internal pages. It's designed to redirect people from http://pip.readthedocs.io/ 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.io/en/develop.) But, it's not a universal redirecting solution. So, for example, a link to an internal page like http://pip.readthedocs.io/usage.html doesn't redirect to http://pip.readthedocs.io/en/latest/usage.html.
30+
This only works for the root URL, not for internal pages. It's designed to redirect people from ``http://pip.readthedocs.io/`` 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.io/en/develop``.) But, it's not a universal redirecting solution. So, for example, a link to an internal page like ``http://pip.readthedocs.io/usage.html`` doesn't redirect to ``http://pip.readthedocs.io/en/latest/usage.html``.
3131

32-
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.io/en/latest/ is the root directory for your default documentation in English, not http://pip.readthedocs.io/. Just like http://pip.readthedocs.io/en/develop/ is the root for your development documentation in English.
32+
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.io/en/latest/`` is the root directory for your default documentation in English, not ``http://pip.readthedocs.io/``. Just like ``http://pip.readthedocs.io/en/develop/`` is the root for your development documentation in English.
3333

3434
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.
3535

docs/user/faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ https://celery.readthedocs.io/projects/kombu/en/latest/
137137

138138
This also works the same for custom domains:
139139

140-
http://docs.celeryproject.org/projects/kombu/en/latest/
140+
http://docs..org/projects/kombu/en/latest/
141141

142142
You can add subprojects in the project admin dashboard.
143143

docs/user/guides/conda.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ with these contents:
134134
You can read more about the :ref:`config-file/v2:build.tools.python` configuration
135135
in our documentation.
136136

137-
.. _mamba: https://quantstack.net/mamba.html
137+
.. _mamba: https://github.com/mamba-org/mamba
138138
.. _a known issue: https://www.anaconda.com/understanding-and-improving-condas-performance/
139139

140140
Mixing conda and pip packages

docs/user/integrations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ On Read the Docs:
108108
On your Gitea instance:
109109

110110
* Go to the :guilabel:`Settings` > :guilabel:`Webhooks` page for your project on your Gitea instance
111-
* Create a new webhook of type "Gitea"
111+
* Create a new webhook of type "Gitea"
112112
* For **URL**, use the URL of the integration on Read the Docs,
113113
found on the :guilabel:`Admin` > :guilabel:`Integrations` page
114114
* Leave the default **HTTP Method** as POST
@@ -197,7 +197,7 @@ Payload validation
197197

198198
If your project was imported through a connected account,
199199
we create a secret for every integration that offers a way to verify that a webhook request is legitimate.
200-
Currently, `GitHub <https://developer.github.com/webhooks/securing/>`__ and `GitLab <https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#secret-token>`__
200+
Currently, `GitHub <https://developer.github.com/webhooks/securing/>`__ and `GitLab <https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#validate-payloads-by-using-a-secret-token>`__
201201
offer a way to check this.
202202

203203
Troubleshooting

docs/user/intro/getting-started-with-mkdocs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ You can make changes to your Markdown files and your docs will automatically reb
6161
Once you have your documentation in a public repository such as GitHub, Bitbucket, or GitLab,
6262
you can start using Read the Docs by :doc:`importing your docs </intro/import-guide>`.
6363

64-
.. _install MkDocs: https://www.mkdocs.org/#installation
64+
.. _install MkDocs: https://www.mkdocs.org/user-guide/installation/
6565

6666
.. warning::
6767

docs/user/tutorial/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ For that, first navigate to your GitHub repository, click on the branch selector
467467
type ``1.0.x``, and click on "Create branch: 1.0.x from 'main'"
468468
(more information `on their documentation`__).
469469

470-
__ https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository
470+
__ https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository
471471

472472
Next, go to your :term:`project home`, click on the :guilabel:`Versions` button,
473473
and under "Active Versions" you will see two entries:

0 commit comments

Comments
 (0)