Включение боковой панели в документации Python-Sphinx на основе темы sphinx-bootstrap

Я использую nice sphinx-bootstrap-theme 0.3.4 и пытаюсь применить его поверх Sphinx Python Documentation Generator версии 1.2.

когда я создаю документацию через make html, Я не получаю никакой боковой панели, хотя показано, что это возможно в этом пример. Кроме того, я смог найти любую опцию для включения боковой панели в файле конфигурации сборки (conf.py). Делаем следующее:

html_sidebars = {'sidebar': ['localtoc.html', 'sourcelink.html', 'searchbox.html']}

не помогает.

Спасибо за любую подсказку о том, как можно включить боковую панель из такой темы Сфинкса.

9
python-sphinx

1 ответов

только что понял. Это должно сработать.

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

используя это в качестве ссылки

Сфинкс тематика руководство html_sidebars

я экспериментирую с созданием пользовательской боковой панели, так как мне не нравятся включенные параметры. Использование демонстрационного индекса bootstrap.html я создал следующее для пользовательской боковой панели. Просто назовите это как my_custom_sidebar.html и поместите его в / source / _templates

<ul class="globaltoc"
>{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False,includehidden=theme_globaltoc_includehidden|tobool) }}</ul>

потом редактировать html_sidebars

html_sidebars = {'**': ['my_custom_sidebar.html', 'searchbox.html']}
14