Заглавия на секции в страничната лента на Sphinx

Има ли някакъв начин да добавите заглавия на секции в лявото меню на документацията на Sphinx? Знам, че можете да го направите, ако използвате MkDocs (например тук), но има ли начин да направите това в Sphinx и ReSTructured text?

Искам да разделя моята документация на отделни секции (напр. Инструкции за инсталиране, Изпълнение на програмата и т.н.), като заглавията на тези секции се показват като текст в лявото меню.


person ostrokach    schedule 29.03.2015    source източник


Отговори (2)


Най-накрая разбрах как можете да го направите в Sphinx...

Има директива :caption:, която ви позволява да добавите надпис към съдържанието. Например съдържанието на readthedocs изглежда така:

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

   getting_started
   versions
   [...]

:caption: User Documentation добавя заглавката на раздела „Потребителска документация“ към страничната лента:

въведете описание на изображението тук

Не знам защо има цялото това бяло пространство след надписа, но предполагам, че това е просто проблем с темата...

person ostrokach    schedule 07.05.2015

В conf.py актуализирайте html_sidebars, както следва:

html_sidebars = {'**': ['localtoc.html']}
person Paul Joireman    schedule 30.03.2015