2013-01-23 8 views
33

Zastanawiam się, czy istnieje sposób na rozszerzenie wszystkich podsekcji pod nagłówkami, które są zawarte w pliku index.rst?Jak rozwinąć wszystkie podsekcje na pasku bocznym toctree w Sphinx

Jako przykład, oto jak to jest:

Section 1 
Section 2 
Section 3 

A oto jak chciałbym go mieć:

Section 1 
    Subsection 1.1 
    Subsection 1.2 
    Subsection 1.3 
Section 2 
    Subsection 2.1 
    Subsection 2.2 
    Subsection 2.3 
Section 3 
    Subsection 3.1 
    Subsection 3.2 
    Subsection 3.3 

Jeśli kliknę sekcji 1, pokazuje, co jest pod to, ale jeśli kliknę w Sekcję 2, zawartość sekcji 1 jest ukryta, a tylko 2 jest pokazane. Chciałbym rozszerzyć wszystkie 2 sekcje za każdym razem, gdy jestem na stronie indeksu. Próbowałem dodać toctree i maxdepth, nic nie działa.

+5

można dodać zawartość Twojego pliku 'index.rst' na pytanie? – ddbeck

+0

Jeśli używasz motywu ReadTheDocs, możesz sprawdzić https://stackoverflow.com/questions/27669376/show-entire-toctree-in-read-the-docs-sidebar – erb

Odpowiedz

5

Cóż, straciłem około 3,4 miliona neuronów próbujących odczytać kod źródłowy sfinksa (napisało to mnóstwo nieokrzesanych, szaleńczych szopów?! ... tyle poziomów abstrakcji).

Więc:

  • zrobić własny sfinks motyw (użyć 3rd party tematu jako baza, bardzo łatwy używam „czytelny” motyw do tego.)
  • w katalogu gdzie masz motyw. conf, dodać "fulltoc.html" szablon, zawierający jedną linię:

fulltoc.html:

{{ toctree(collapse=False) }} 

(Hej, zwróć uwagę na argument "zwinięcia"?)

  • w sphinx conf.py, zmodyfikuj opcję html_sidebars, aby dodać swój szablon; i deklarują swoją motyw

conf.py:

html_theme_path = [customized_readable_theme.get_html_theme_path()] 
html_theme = 'customized_readable' 
html_sidebars = {'**': ['fulltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']} 
  • odbudowania dokumentacja
+0

Dałam ci sto + 1 jeśli mógłbym. Dzięki. – EugZol

Powiązane problemy