IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Clarify what happens if no title is used in the :ref:

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez
2021-06-22 15:44:52 +02:00
parent 15fe52dce6
commit 013e67f4fd
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/tutorial/index.rst
View File

@@ -440,7 +440,9 @@ And make the sentence you added in ``index.rst`` look like this:
Notice a trick here: the ``install`` part specifies how the link will look like
(we want it to be a specific word, so the sentence makes sense), whereas the
``<installation>`` part refers to the actual label we want to add a
cross-reference to. Both the ``:doc:`` and the ``:ref:`` roles will be rendered
cross-reference to. If you do not include an explicit title, hence using
``:ref:`installation```, the section title will be used (in this case,
``Installation``). Both the ``:doc:`` and the ``:ref:`` roles will be rendered
as hyperlinks in the HTML documentation.
Where to go from here