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

Fix #3106: domain: Register hyperlink target for index page automatically

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-02-08 12:23:11 +09:00
parent 973c91bb10
commit 9db38aadfd
5 changed files with 37 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/development/tutorials/recipe.rst
View File

@@ -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,