Używanie siebie do tworzenia mapy witryny z toctree w sfinksie wydaje się zepsute?

Question

Aktualizuję często zadawane pytania dotyczące dość dużego projektu i chciałbym dodać indeks pytań u góry strony, aby użytkownicy mogli łatwiej znaleźć to, czego szukają.

Dokumentacja Sphinx toctree article stwierdza "Specjalna nazwa wpisu oznacza dokument zawierający dyrektywę Toctree. Jest to przydatne, jeśli chcesz wygenerować" mapę witryny "z pliku potwierdzenia." Tego właśnie chcę. Problem polega na tym, że self wydaje się zepsuty i zawiera tylko bieżący tytuł dokumentu, a nie napisy. Działa poprawnie, gdy znajduję się w innym dokumencie i odwołuje się do FAQ, tylko w samym dokumencie nie działa.

Aby zademonstrować

.. toctree:: 
    :maxdepth: 3 

    faq 

W innych wyników plików w

• Najczęściej zadawane pytania
  • FAQ
    • Pytanie 1
    • Qu estion 2
    • Pytanie 3
  • nieoczywisty zachowanie i inne potrzeby, aby wiedzieć

Inside FAQ

.. toctree:: 
    :maxdepth: 3 

    self 

skutkuje

• Fre często zadawane pytania

Myślałem, że być może dlatego, że sfinks nie był świadomy napisów, kiedy konwertowany jest Toctree i próbował przenieść TOCtree na dół strony. Bez zmiany.

Wszelkie pomysły, w jaki sposób zawierać indeks strony w samej stronie z sfinks byłoby bardzo mile widziane

Answer 1

co twój szukasz jest dyrektywa contents.

Wstaw następujący blok po tytule swojej stronie budować listę pytań:

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

To będzie produkować:

• Pytanie 1
• Pytanie 2
• Pytanie 3