class documentation

class index(nodes.Invisible, nodes.Inline, nodes.TextElement):

View In Hierarchy

Node for index entries.

This node is created by the index directive and has one attribute, entries. Its value is a list of 5-tuples of (entrytype, entryname, target, ignored, key).

entrytype is one of "single", "pair", "double", "triple".

key is categorization characters (usually a single character) for general index page. For the details of this, please see also: :rst:dir:`glossary` and issue #2320.