diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-02-23 12:27:57 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-23 12:27:57 +0900 |
| commit | bfce1a71f66a09674c82a06a028beb76ead71089 (patch) | |
| tree | da675337788c2faa59ea3874785c4f330d14e57f /doc/usage/restructuredtext | |
| parent | bd28aa58d51e43712c1743d450cc723b5abbf945 (diff) | |
| parent | 2d2833486237f855a99e0868b33c3198470ffde4 (diff) | |
| download | sphinx-git-bfce1a71f66a09674c82a06a028beb76ead71089.tar.gz | |
Merge pull request #7087 from geographika/named-index-links
Add name option for the index directive
Diffstat (limited to 'doc/usage/restructuredtext')
| -rw-r--r-- | doc/usage/restructuredtext/directives.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/usage/restructuredtext/directives.rst b/doc/usage/restructuredtext/directives.rst index 291a6ddc0..b5b0a2980 100644 --- a/doc/usage/restructuredtext/directives.rst +++ b/doc/usage/restructuredtext/directives.rst @@ -874,6 +874,19 @@ mainly contained in information units, such as the language reference. .. versionchanged:: 1.1 Added ``see`` and ``seealso`` types, as well as marking main entries. + .. rubric:: options + + .. rst:directive:option:: name: a label for hyperlink + :type: text + + Define implicit target name that can be referenced by using + :rst:role:`ref`. For example:: + + .. index:: Python + :name: py-index + + .. versionadded:: 3.0 + .. rst:role:: index While the :rst:dir:`index` directive is a block-level markup and links to the |