Skip to content

Commit

Permalink
Merge pull request #51753 from terminal-labs/docs-sphinx-ref-deadlink…
Browse files Browse the repository at this point in the history
…-fix

Docs sphinx ref and role terminology dead link replaced
  • Loading branch information
twangboy committed Mar 21, 2019
2 parents efb9ec0 + f2b6abd commit 838a7aa
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc/Makefile
Expand Up @@ -66,7 +66,7 @@ clean:

# User-friendly check for sphinx-build
check_sphinx-build:
@which $(SPHINXBUILD) >/dev/null 2>&1 || (echo "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)" >&2; false)
@which $(SPHINXBUILD) >/dev/null 2>&1 || (echo "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://www.sphinx-doc.org/en/master/)" >&2; false)

html: check_sphinx-build translations
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
Expand Down
10 changes: 5 additions & 5 deletions doc/topics/development/conventions/documentation.rst
Expand Up @@ -13,7 +13,7 @@ broadly, most of the narrative documentation is contained within the
:blob:`doc` subdirectory and most of the reference and API documentation is
written inline with Salt's Python code and extracted using a Sphinx extension.

.. _`Sphinx`: http://sphinx-doc.org/
.. _`Sphinx`: https://www.sphinx-doc.org/en/master/


.. _docs-style:
Expand Down Expand Up @@ -187,7 +187,7 @@ Link to :ref:`glossary entries <glossary>` using the `term role`_. A
cross-reference should be added the first time a Salt-specific term is used in
a document.

.. _`term role`: http://sphinx-doc.org/markup/inline.html#role-term
.. _`term role`: https://www.sphinx-doc.org/en/master/glossary.html#term-role

.. code-block:: restructuredtext
Expand All @@ -206,7 +206,7 @@ occasionally useful to manually add items to the index.
One method is to use the `index directive`_ above the document or section that
should appear in the index.

.. _`index directive`: http://sphinx-doc.org/markup/misc.html#directive-index
.. _`index directive`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=index%20directive#index-generating-markup

.. code-block:: restructuredtext
Expand All @@ -217,7 +217,7 @@ Another method is to use the `index role`_ inline with the text that should
appear in the index. The index entry is created and the target text is left
otherwise intact.

.. _`index role`: http://sphinx-doc.org/markup/misc.html#role-index
.. _`index role`: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#role-index

.. code-block:: restructuredtext
Expand Down Expand Up @@ -252,7 +252,7 @@ to survive document renames or movement.
Note, the ``:doc:`` role should *not* be used to link documents together.

.. _`ref role`: http://sphinx-doc.org/markup/inline.html#role-ref
.. _`ref role`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref


.. _docs-ref-modules:
Expand Down
4 changes: 3 additions & 1 deletion doc/topics/development/hacking.rst
Expand Up @@ -283,7 +283,9 @@ Change to salt documentation directory, then:
:strong:`text`.
- The docs then are built within the :strong:`docs/_build/` folder. To update
the docs after making changes, run ``make`` again.
- The docs use `reStructuredText <http://sphinx-doc.org/rest.html>`_ for markup.
- The docs use `reStructuredText
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
for markup.
See a live demo at http://rst.ninjs.org/.
- The help information on each module or state is culled from the python code
that runs for that piece. Find them in ``salt/modules/`` or ``salt/states/``.
Expand Down

0 comments on commit 838a7aa

Please sign in to comment.