Include root_doc in toc

[WhyNotHugo]

How can I include the root_doc in my toc? I tried the following, which don't work:

.. toctree::
    :hidden:

    master_doc
    root_doc
    index
    content

Output:

reading sources... [100%] index
…/index.rst:5: WARNING: toctree contains reference to nonexisting document 'master_doc' [toc.not_readable]
…/index.rst:5: WARNING: toctree contains reference to nonexisting document 'root_doc' [toc.not_readable]
…/index.rst:5: WARNING: toctree contains reference to nonexisting document 'index' [toc.not_readable]
…/index.rst:5: WARNING: toctree contains reference to nonexisting document 'content' [toc.not_readable]

[AA-Turner]

The root toctree directive must be located in the master document. The idea is to form a directed acylic tree. I would have thought that either index or contents (depending on the value of your master_doc or root_doc config value) would work, though.

A

[WhyNotHugo]

index did work previously; I just came across an older project of mine published in readthedocs which uses index and it worked. It no longer works on the latest sphinx.

[chrisjsewell]

Heya, maybe you are after the self key, as mentioned in https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree:

The special entry name self stands for the document containing the toctree directive.

[WhyNotHugo]

Thanks, this works!

[WhyNotHugo]

This renders an entry for the page itself, but not for subtitles. I've set :maxdepth: 2, and subtitles for other pages do render. Is there something special about the root one?

[david-cortes-intel]

Can also confirm that it works.