1.12. Index Entries

1.12.1. Inline (single) index entires

This is how we write in reStructuredText

:index:`Inlined <inlined-entry>` :index:`index` :index:`entry`

Inlined index entry

The generated entries are:

  • inlined-entry
  • index
  • entry

1.12.2. Single index entry

This is how we write in reStructuredText

.. index:: single
.. index:: explicit-one
.. index:: explicit single line

The generated entries are:

  • single
  • explicit-one
  • explicit single line

1.12.3. Double (paired) index entries

This is how we write in reStructuredText

.. index::
   pair: double; index entries
   pair: paired; index entries
   pair: two; index entries

The generated entries are:

  • double
    • index entries
  • index entries
    • double
    • paired
    • two
  • paired
    • index entries
  • two
    • index entries

1.12.4. Triple index entries

This is how we write in reStructuredText

.. index::
   triple: three; tres; drei

Three index entires, THREE in English, TRES in Spanish, DREI in German.

The generated entries are:

  • tres
    • drei, three
  • drei
    • three, tres
  • three
    • tres, drei