theme the read docs python documentation python-sphinx sidebar

python - read the docs theme



Cómo expandir todas las subsecciones en la barra lateral a árbol en Sphinx (1)

Me preguntaba si hay una forma de expandir todas las subsecciones debajo de los encabezados que se incluyen en el archivo index.rst ?

Como ejemplo, aquí está cómo es:

Section 1 Section 2 Section 3

Y así es como me gustaría que fuera:

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

Si hago clic en la Sección 1, se muestra lo que hay debajo de eso, pero si hago clic en la Sección 2, el contenido de la sección 1 queda oculto y solo se muestra 2. Me gustaría que las 2 secciones se expandan cada vez que estoy en la página de índice. He intentado agregar toctree y maxdepth , nada funciona.


Bueno, perdí aproximadamente 3,4 millones de neuronas tratando de leer el código fuente de la esfinge (¿estaba escrito por un montón de rabiosos mapaches imprudentes?! Tantos niveles de abstracción).

Asi que :

  • crea tu propio tema de esfinge (utiliza un tema de terceros como base, muy fácil. Utilizo el tema "legible" para eso)
  • en el directorio donde tiene theme.conf, agregue una plantilla "fulltoc.html", que contiene una línea:

fulltoc.html:

{{ toctree(collapse=False) }}

(Heh, ¿te fijas en el argumento del "colapso"?)

  • en sphinx conf.py, modifique la opción html_sidebars para agregar su plantilla; y declara tu tema

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'']}

  • reconstruir la documentación