Wednesday, March 10, 2010

Auto-generated index in Sphinx

Sphinx allows to create auto-generated index. To do it, add index directive into your .rst files. Sphinx will generate genindex.html file with indexes.
If the genindex.html is not created, make sure the html_use_index option is set to True in the file.
Use the :ref:`genindex` reference to add link to the Index.

No comments:

Post a Comment