python sphinx - software - Cómo incluir el árbol de texto en la barra lateral de cada página

sphinx software

Question

Estoy generando documentación html en Sphinx.

¿Cómo modifico la barra lateral de cada una de las páginas html en mi documento para que incluyan el toctree? Por defecto, el toctree solo parece mostrarse en la página master_doc , y solo en el área principal en lugar de en la barra lateral.

¿Hay una forma fácil de hacer esto? Utilizaré readthedocs para alojar la documentación generada, por lo que preferiría evitar el uso de complementos de terceros, a menos que también estén disponibles en readthedocs.

Answer 1

Incluir el ''globaltoc.html'' tiene un inconveniente ya que no muestra el toc global y local de la página que está viendo.

Parece que a otros les molestaba esta limitación y resultó en el desarrollo posterior de una extensión para admitir un toc completo en la barra lateral, checkout: https://pypi.python.org/pypi/sphinxcontrib-fulltoc

Answer 2

Puede personalizar su barra lateral html en conf.py

La barra lateral html predeterminada consta de 4 plantillas:

[''localtoc.html'', ''relations.html'', ''sourcelink.html'', ''searchbox.html'']

En conf.py puedes cambiar localtoc.html a globaltoc.html como este:

html_sidebars = { ''**'': [''globaltoc.html'', ''relations.html'', ''sourcelink.html'', ''searchbox.html''] }

Como esto al final esto se usará en archivos HTML, esto debería funcionar en ReadTheDocs.