Skip to content

Fix broken Sphinx Links #1024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from Dec 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/notes/styleguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Strive to keep any contributions relevant to the :ref:`purpose of The Guide
relate to Python development.
* Prefer to link to other sources if the information is already out there.
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.
* 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
Expand Down Expand Up @@ -146,14 +146,14 @@ Externally Linking

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
links:

.. 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
descriptive labels (SEO worthy) instead.
Expand All @@ -164,7 +164,7 @@ Linking to Sections in The Guide
********************************

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.

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

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:

Expand All @@ -205,7 +205,7 @@ TODOs
*****

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
documents or large incomplete sections.

Expand Down
4 changes: 2 additions & 2 deletions docs/writing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ structured and easily readable documentation for your project.
for general project documentation. This Guide is built with
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

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

.. _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


Expand Down