diff options
| author | shimizukawa <shimizukawa@gmail.com> | 2016-05-25 22:59:03 +0900 |
|---|---|---|
| committer | shimizukawa <shimizukawa@gmail.com> | 2016-05-25 22:59:03 +0900 |
| commit | 03af1ca4dda22841bc616d134c3a101aa97c9a42 (patch) | |
| tree | 3027f7d6607a09dd5eef436d6c77faf1fc327fa7 /sphinx/addnodes.py | |
| parent | 9cd5ba994cdf539acda28cd91bee54589e068991 (diff) | |
| download | sphinx-git-03af1ca4dda22841bc616d134c3a101aa97c9a42.tar.gz | |
add docstring to write more detail of 'key' of index node
Diffstat (limited to 'sphinx/addnodes.py')
| -rw-r--r-- | sphinx/addnodes.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index 311aa232b..8c4e39e75 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -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. """ |