diff options
author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-08-09 14:05:55 +0200 |
---|---|---|
committer | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-08-12 20:06:56 +0200 |
commit | 1a1e45f1af84dd2b5ee315137191da49974d5303 (patch) | |
tree | bca27ce635d3bd681f134e3408945d746f841fc8 /doc/tutorial | |
parent | 1acdf4f8735d40b875161a94c1e0124aceb14217 (diff) | |
download | sphinx-git-1a1e45f1af84dd2b5ee315137191da49974d5303.tar.gz |
Add cross reference to role definitions
Diffstat (limited to 'doc/tutorial')
-rw-r--r-- | doc/tutorial/narrative-documentation.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/tutorial/narrative-documentation.rst b/doc/tutorial/narrative-documentation.rst index d29db1d77..adef47649 100644 --- a/doc/tutorial/narrative-documentation.rst +++ b/doc/tutorial/narrative-documentation.rst @@ -85,8 +85,9 @@ introduction paragraph in ``index.rst``: Check out the :doc:`usage` section for further information. -The :rst:role:`doc` role you used automatically references a specific document -in the project, in this case the ``usage.rst`` you created earlier. +The :rst:role:`doc` :ref:`role <rst-roles-alt>` you used automatically +references a specific document in the project, in this case the ``usage.rst`` +you created earlier. Alternatively, you can also add a cross-reference to an arbitrary part of the project. For that, you need to use the :rst:role:`ref` role, and add an |