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

add docstring to write more detail of 'key' of index node

Browse Source
This commit is contained in:
shimizukawa 2016-05-25 22:59:03 +09:00
parent 9cd5ba994c
commit 03af1ca4dd
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sphinx/addnodes.py
View File

@ -120,6 +120,10 @@ class index(nodes.Invisible, nodes.Inline, nodes.TextElement):
target, ignored, key)``.
*entrytype* is one of "single", "pair", "double", "triple".
*key* is categolziation characters (usually it is single character) for
general index page. For the detail of this, please see also:
:rst:directive:`glossary` and issue #2320.
"""