How can i include the `genindex` in a Sphinx TOC? -


sphinx generates index named genindex when building documentation , therefore forbids use name document. now, how include link index in table of contents?

i've tried this:

.. toctree::    :maxdepth: 2     genindex    api   indices , tables ==================  * :ref:`genindex` 

while last line create link index in document, build doesn't know reference when creating toc:

warning: toctree contains reference nonexisting document 'genindex' 

create file genindex.rst following content:

index ===== 

in index.rst add:

.. toctree::    :hidden:     genindex 

if you want have link , text "index" on site , not in left navigation remove :hidden:


Comments