summaryrefslogtreecommitdiff
path: root/doc/development/tutorials
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2020-02-08 12:23:11 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2020-02-22 18:20:12 +0900
commit9db38aadfdb64fea3e1ae50264a096e17c1e0d69 (patch)
tree8da85bc8a8c099a365fa4055982e847f8ca2856a /doc/development/tutorials
parent973c91bb1013ba977b87c20ade5e34d235f75778 (diff)
downloadsphinx-git-9db38aadfdb64fea3e1ae50264a096e17c1e0d69.tar.gz
Fix #3106: domain: Register hyperlink target for index page automatically
Diffstat (limited to 'doc/development/tutorials')
-rw-r--r--doc/development/tutorials/recipe.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/development/tutorials/recipe.rst b/doc/development/tutorials/recipe.rst
index 474888cb0..dcfe42c1a 100644
--- a/doc/development/tutorials/recipe.rst
+++ b/doc/development/tutorials/recipe.rst
@@ -122,6 +122,10 @@ all it really is is a list of tuples like ``('tomato', 'TomatoSoup', 'test',
'rec-TomatoSoup',...)``. Refer to the :doc:`domain API guide
</extdev/domainapi>` for more information on this API.
+These index pages can be referred by combination of domain name and its
+``name`` using :rst:role:`ref` role. For example, ``RecipeIndex`` can be
+referred by ``:ref:`recipe-recipe```.
+
.. rubric:: The domain
A Sphinx domain is a specialized container that ties together roles,