Index Template#

Use the copy button and paste the template into your new index.


Note

Change the highlighted line numbers 3, 6 and 8 to suit you use case.


Tip

Remove the optional highlighted toctree options that aren’t required.

See Sphinx toctree for more information about toctree options.


Index Page Template#
 1.. include:: /extras.rst.txt
 2.. highlight:: rst
 3.. index:: template-index ; Index
 4
 5
 6.. _template-index:
 7================
 8Index Title Here
 9================
10
11An optional brief description describes the index.
12
13
14.. toctree::
15   :titlesonly:
16   :maxdepth: int
17   :hidden:
18   :caption:
19   :includehidden:
20   :reversed:
21   :numbered:
22   :glob:
Format to include pages in the TOC#
    to include .rst files in the TOC

    /path-to-first-page
    /path-to-second-page

    to include markdown files in the TOC use the full name with file extension

    /path/to/markdown-file.md