L'uso di toctree self in sphinx non include le sottosezioni

Question

Vorrei che il mio toctree in sfinge includesse la pagina principale (index.rst). I documenti suggeriscono che includendo 'self' lo farà, ma come altri hanno notato su stackoverflow questo include solo il titolo della pagina principale, in modo che se profondità> 1 il comportamento per la pagina principale sia diverso dalle pagine collegate.

Ho anche visto la direttiva sui contenuti suggerita per questo problema, per me questo solo crea un elenco locale separato di contenuti e non aiuta con il toctree. Sto davvero cercando una soluzione che produca un comportamento coerente nel toctree. Ce n'è uno?

Answer 1

Includendo il valore letterale self, è sufficiente aggiungere il titolo del documento corrente come indicato. Tuttavia, incluso il titolo del documento corrente, in realtà lo aggiunge all'albero. Ad esempio,

.. toctree:: 
    :maxdepth: 2 

    index 

produrrà il risultato desiderato. Non sono sicuro del motivo per cui questo non è esplicitamente elencato nella documentazione da qualche parte.