Skip to content

Commit 03af1ca

Browse files
committed
add docstring to write more detail of 'key' of index node
1 parent 9cd5ba9 commit 03af1ca

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

sphinx/addnodes.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,10 @@ class index(nodes.Invisible, nodes.Inline, nodes.TextElement):
120120
target, ignored, key)``.
121121
122122
*entrytype* is one of "single", "pair", "double", "triple".
123+
124+
*key* is categolziation characters (usually it is single character) for
125+
general index page. For the detail of this, please see also:
126+
:rst:directive:`glossary` and issue #2320.
123127
"""
124128

125129

0 commit comments

Comments
 (0)