Skip to content

Commit 316c4b1

Browse files
authored
Merge pull request #1024 from davidwales/patch-1
Fix broken Sphinx Links
2 parents e9f7da8 + 5292e8c commit 316c4b1

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

Diff for: docs/notes/styleguide.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Strive to keep any contributions relevant to the :ref:`purpose of The Guide
3131
relate to Python development.
3232
* Prefer to link to other sources if the information is already out there.
3333
Be sure to describe what and why you are linking.
34-
* `Cite <http://sphinx.pocoo.org/rest.html?highlight=citations#citations>`_
34+
* `Cite <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#citations>`_
3535
references where needed.
3636
* If a subject isn't directly relevant to Python, but useful in conjunction
3737
with Python (e.g., Git, GitHub, Databases), reference by linking to useful
@@ -146,14 +146,14 @@ Externally Linking
146146
147147
Sphinx_ is used to document Python.
148148
149-
.. _Sphinx: http://sphinx.pocoo.org
149+
.. _Sphinx: https://www.sphinx-doc.org
150150
151151
* Prefer to use descriptive labels with inline links instead of leaving bare
152152
links:
153153

154154
.. code-block:: rest
155155
156-
Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_
156+
Read the `Sphinx Tutorial <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_
157157
158158
* Avoid using labels such as "click here", "this", etc., preferring
159159
descriptive labels (SEO worthy) instead.
@@ -164,7 +164,7 @@ Linking to Sections in The Guide
164164
********************************
165165

166166
To cross-reference other parts of this documentation, use the `:ref:
167-
<http://sphinx.pocoo.org/markup/inline.html#cross-referencing-arbitrary-locations>`_
167+
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref>`_
168168
keyword and labels.
169169

170170
To make reference labels more clear and unique, always add a ``-ref`` suffix:
@@ -182,7 +182,7 @@ Notes and Warnings
182182
******************
183183

184184
Make use of the appropriate `admonitions directives
185-
<http://sphinx.pocoo.org/rest.html#directives>`_ when making notes.
185+
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives>`_ when making notes.
186186

187187
Notes:
188188

@@ -205,7 +205,7 @@ TODOs
205205
*****
206206

207207
Please mark any incomplete areas of The Guide with a `todo directive
208-
<http://sphinx.pocoo.org/ext/todo.html?highlight=todo#directive-todo>`_. To
208+
<https://www.sphinx-doc.org/en/master/usage/extensions/todo.html>`_. To
209209
avoid cluttering the :ref:`todo-list-ref`, use a single ``todo`` for stub
210210
documents or large incomplete sections.
211211

Diff for: docs/writing/documentation.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ structured and easily readable documentation for your project.
8585
for general project documentation. This Guide is built with
8686
Sphinx_ and is hosted on `Read The Docs`_
8787

88-
.. _Sphinx: http://sphinx.pocoo.org
88+
.. _Sphinx: https://www.sphinx-doc.org
8989
.. _Read The Docs: http://readthedocs.org
9090

9191
.. _restructuredtext-ref:
@@ -100,7 +100,7 @@ The `reStructuredText Primer`_ and the `reStructuredText Quick
100100
Reference`_ should help you familiarize yourself with its syntax.
101101

102102
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
103-
.. _reStructuredText Primer: http://sphinx.pocoo.org/rest.html
103+
.. _reStructuredText Primer: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
104104
.. _reStructuredText Quick Reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html
105105

106106

0 commit comments

Comments
 (0)