L'uso di sé per creare una sitemap con toctree nella sfinge sembra rotto?

Question

Sto aggiornando una FAQ per un progetto abbastanza grande e vorrei aggiungere un indice delle domande nella parte superiore della pagina, in modo che gli utenti possano trovare più facilmente ciò che stanno cercando.

La documentazione della Sfinge toctree article stati "Il nome della voce speciale self sta per il documento contenente la direttiva toctree.Questo è utile se si desidera generare una" sitemap "dal toctree." Questo è quello che voglio. Il problema è che il sé sembra rotto e include solo il titolo dei documenti correnti e non i sottotitoli. Funziona correttamente quando sono in un altro documento e fa riferimento alle FAQ, solo nel documento stesso non riesce.

Per dimostrare

.. toctree:: 
    :maxdepth: 3 

    faq 

In altri risultati di file in

• Domande frequenti
  • frequenti
    • Domanda 1
    • Qu estion 2
    • Domanda 3
  • Comportamento non-ovvio e altri hanno bisogno di sapere

All'interno faq

.. toctree:: 
    :maxdepth: 3 

    self 

risultati in

• Fre quently Asked Questions

Ho pensato che forse era perché la sfinge non era a conoscenza dei sottotitoli quando il toctree viene convertito e provato a spostare il toctree in fondo alla pagina. Nessun cambiamento.

Tutte le idee su come includere un indice di una pagina nella pagina stessa con sfinge sarebbe molto apprezzato

Answer 1

ciò che stai cercando è la direttiva contents.

Inserire il seguente blocco dopo il titolo della pagina per creare l'elenco di domande:

.. contents:: 
    :local: 
    :depth: 1 

produrrà:

• Domanda 1
• Domanda 2
• Domanda 3