Заголовки разделов на боковой панели Sphinx

Question

Есть ли способ добавить названия разделов в левом меню документации Sphinx? Я знаю, что вы можете это сделать, если используете MkDocs (например, here), но есть ли способ сделать это в Sphinx и ReSTructured text?

Я хочу разделить мою документацию на отдельные разделы (например, инструкции по установке, запуск программы и т. Д.), Причем заголовки этих разделов отображаются в виде текста в левом меню.

Answer 1

Наконец понял, как вы можете это сделать в Сфинкса ...

Существует :caption: директива, которая позволяет добавить название оглавление. Например, таблица содержания для readthedocs выглядит следующим образом:

.. toctree:: 
    :maxdepth: 2 
    :caption: User Documentation # <-- This is what I was looking for 

    getting_started 
    versions 
    [...] 

:caption: User Documentation добавляет «Документация пользователя» заголовок раздела на боковой панели:

Я не знаю, почему это все, что wite-space после заголовка, но я думаю, что это просто проблема с темой ...

Answer 2

В conf.py обновления в html_sidebars следующим образом:

html_sidebars = {'**': ['localtoc.html']}