Я создаю html-документацию в Sphinx.
Как изменить боковую панель для каждой из html-страниц в моем документе, чтобы они включали toctree? По умолчанию toctree только отображается на странице master_doc и только в основной области, а не на боковой панели.
Есть ли простой способ сделать это? Я буду использовать readthedocs для размещения сгенерированной документации, поэтому я предпочел бы избежать использования каких-либо сторонних плагинов, если они также не доступны для readthedocs.
Вы можете настроить свою боковую панель html в conf.py.
По умолчанию html sidebar состоит из 4 шаблонов:
['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
В conf.py вы можете изменить localtoc.html на globaltoc.html следующим образом:
html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'], }
Но я не уверен, работает ли это на readthedocs.
Включение "globaltoc.html" имеет недостаток в том, что он не отображает глобальный и локальный toc для просматриваемой страницы.
Похоже, что другие были раздражены этим ограничением и привели к последующей разработке расширения для поддержки полного toc на боковой панели, checkout: https://pypi.python.org/pypi/sphinxcontrib-fulltoc