kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1024 from davidwales/patch-1

Browse Source 
Fix broken Sphinx Links
This commit is contained in:
Dan Bader
2019-12-11 21:08:03 -08:00
committed by GitHub
parent e9f7da8018 5292e8c587
commit 316c4b1742
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/notes/styleguide.rst
+6 -6
View File
@@ -31,7 +31,7 @@ Strive to keep any contributions relevant to the :ref:`purpose of The Guide
relate to Python development. relate to Python development.
* Prefer to link to other sources if the information is already out there. * Prefer to link to other sources if the information is already out there.
Be sure to describe what and why you are linking. Be sure to describe what and why you are linking.
* `Cite <http://sphinx.pocoo.org/rest.html?highlight=citations#citations>`_ * `Cite <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#citations>`_
references where needed. references where needed.
* If a subject isn't directly relevant to Python, but useful in conjunction * If a subject isn't directly relevant to Python, but useful in conjunction
with Python (e.g., Git, GitHub, Databases), reference by linking to useful with Python (e.g., Git, GitHub, Databases), reference by linking to useful
@@ -146,14 +146,14 @@ Externally Linking
Sphinx_ is used to document Python. Sphinx_ is used to document Python.
.. _Sphinx: http://sphinx.pocoo.org .. _Sphinx: https://www.sphinx-doc.org
* Prefer to use descriptive labels with inline links instead of leaving bare * Prefer to use descriptive labels with inline links instead of leaving bare
links: links:
.. code-block:: rest .. code-block:: rest
Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_ Read the `Sphinx Tutorial <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_
* Avoid using labels such as "click here", "this", etc., preferring * Avoid using labels such as "click here", "this", etc., preferring
descriptive labels (SEO worthy) instead. descriptive labels (SEO worthy) instead.
@@ -164,7 +164,7 @@ Linking to Sections in The Guide
******************************** ********************************
To cross-reference other parts of this documentation, use the `:ref: To cross-reference other parts of this documentation, use the `:ref:
<http://sphinx.pocoo.org/markup/inline.html#cross-referencing-arbitrary-locations>`_ <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref>`_
keyword and labels. keyword and labels.
To make reference labels more clear and unique, always add a ``-ref`` suffix: To make reference labels more clear and unique, always add a ``-ref`` suffix:
@@ -182,7 +182,7 @@ Notes and Warnings
****************** ******************
Make use of the appropriate `admonitions directives Make use of the appropriate `admonitions directives
<http://sphinx.pocoo.org/rest.html#directives>`_ when making notes. <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives>`_ when making notes.
Notes: Notes:
@@ -205,7 +205,7 @@ TODOs
***** *****
Please mark any incomplete areas of The Guide with a `todo directive Please mark any incomplete areas of The Guide with a `todo directive
<http://sphinx.pocoo.org/ext/todo.html?highlight=todo#directive-todo>`_. To <https://www.sphinx-doc.org/en/master/usage/extensions/todo.html>`_. To
avoid cluttering the :ref:`todo-list-ref`, use a single ``todo`` for stub avoid cluttering the :ref:`todo-list-ref`, use a single ``todo`` for stub
documents or large incomplete sections. documents or large incomplete sections.
docs/writing/documentation.rst
+2 -2
View File
@@ -85,7 +85,7 @@ structured and easily readable documentation for your project.
for general project documentation. This Guide is built with for general project documentation. This Guide is built with
Sphinx_ and is hosted on `Read The Docs`_ Sphinx_ and is hosted on `Read The Docs`_
.. _Sphinx: http://sphinx.pocoo.org .. _Sphinx: https://www.sphinx-doc.org
.. _Read The Docs: http://readthedocs.org .. _Read The Docs: http://readthedocs.org
.. _restructuredtext-ref: .. _restructuredtext-ref:
@@ -100,7 +100,7 @@ The `reStructuredText Primer`_ and the `reStructuredText Quick
Reference`_ should help you familiarize yourself with its syntax. Reference`_ should help you familiarize yourself with its syntax.
.. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _reStructuredText Primer: http://sphinx.pocoo.org/rest.html .. _reStructuredText Primer: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _reStructuredText Quick Reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html .. _reStructuredText Quick Reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html