13. Index Entries

13.1. Inline (single) index entires

When the write with the following reStructuredText markup / syntax:

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

Inlined index entry

The generated entries are:

• inlined-entry

• index

• entry

Single index entry ============================================================================``````````````

When the write with the following reStructuredText markup / syntax:

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

The generated entries are:

• single

• explicit-one

• explicit single line

Double (paired) index entries ============================================================================````````````````````

When the write with the following reStructuredText markup / syntax:

.. 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

Triple index entries ============================================================================````````````````````

When the write with the following reStructuredText markup / syntax:

.. 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