@@ -31,7 +31,7 @@ Strive to keep any contributions relevant to the :ref:`purpose of The Guide
31
31
relate to Python development.
32
32
* Prefer to link to other sources if the information is already out there.
33
33
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 >`_
35
35
references where needed.
36
36
* If a subject isn't directly relevant to Python, but useful in conjunction
37
37
with Python (e.g., Git, GitHub, Databases), reference by linking to useful
@@ -146,14 +146,14 @@ Externally Linking
146
146
147
147
Sphinx_ is used to document Python.
148
148
149
- .. _Sphinx: http ://sphinx.pocoo .org
149
+ .. _Sphinx: https ://www.sphinx-doc .org
150
150
151
151
* Prefer to use descriptive labels with inline links instead of leaving bare
152
152
links:
153
153
154
154
.. code-block :: rest
155
155
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>`_
157
157
158
158
* Avoid using labels such as "click here", "this", etc., preferring
159
159
descriptive labels (SEO worthy) instead.
@@ -164,7 +164,7 @@ Linking to Sections in The Guide
164
164
********************************
165
165
166
166
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 > `_
168
168
keyword and labels.
169
169
170
170
To make reference labels more clear and unique, always add a ``-ref `` suffix:
@@ -182,7 +182,7 @@ Notes and Warnings
182
182
******************
183
183
184
184
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.
186
186
187
187
Notes:
188
188
@@ -205,7 +205,7 @@ TODOs
205
205
*****
206
206
207
207
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
209
209
avoid cluttering the :ref: `todo-list-ref `, use a single ``todo `` for stub
210
210
documents or large incomplete sections.
211
211
0 commit comments