Показать все toctree на боковой панели Read The Docs

Насколько я понимаю, новая тема Read The Docs генерирует боковую панель из toctree с глубиной 2. Моя документация относительно глубокая, и глубины 2 недостаточно, чтобы она была полезной. Как я могу увеличить этот лимит или, что лучше, полностью удалить его?

Если это невозможно, как я могу использовать локальные ToC вместо глобального toctree?


person Kevin    schedule 27.12.2014    source источник


Ответы (2)


Примечание. Предыдущий ответ устарел. Как отмечает @Ariel в комментарии, maxdepth теперь можно настроить, установив navigation_depth в html_theme_options. Согласно README, измените это в файле conf.py вашего проекта:

html_theme_options = {
    'navigation_depth': 4,
}

Глядя на исходник темы на Github, кажется, что глубина ToC жестко запрограммирована на строка 93 в sphinx_rtd_theme/layout.html. Таким образом, вы не можете настроить тему, чтобы переопределить ее.

Поскольку строка жестко закодирована, вы всегда будете получать глобальное toctree, возвращаемое toctree, вместо локального, «поддерживаемого» следующими строками.

Вы, конечно, можете создать форк темы и изменить эту строку для локального использования (и вы можете использовать пользовательские темы в RTD, так что там тоже должно работать). Я попытался сделать это с демонстрационной темой. Это выглядит так с maxdepth=3, поэтому может потребоваться дополнительный CSS. В документации для функции шаблона toctree указано, что для неограниченной глубины просто передайте maxdepth=-1. Обратите внимание, что это не добавляет свертывания/расширения к подуровням оглавления.

Может ли быть хорошей целью для запроса на включение?

Демонстрационная тема с tocdepth=3

person vicvicvic    schedule 04.01.2015
comment
Разве это не боковая панель с более чем двумя уровнями? read-the-docs.readthedocs.org/en/latest/getting_started. html Как я могу имитировать это поведение? Он показывает несколько уровней только тогда, когда я использую элемент с подэлементами, но для меня этого достаточно. - person Ariel; 08.12.2015
comment
Хорошо, я был на версии 0.1.6, видимо они добавили поддержку глубины 3 и 4 в версии 0.1.8: github.com/snide/sphinx_rtd_theme#v0-1-8 - person Ariel; 08.12.2015
comment
Работает ли это в онлайн-версии RTD? У меня это работает только локально, см. соответствующий выпуск на Github - person Michael Goerz; 11.03.2017
comment
Для глубины выше 4 боковая панель ведет себя неправильно. Например, у тем не будет правильного отступа относительно родительских тем. - person AmiguelS; 21.12.2017

Нет возможности настроить это поведение, по крайней мере, в ReadTheDocs. Тем не менее, вы все равно можете прочитать дополнительные слои деталей на страницах — они просто не отображаются в навигации.

person felixphew    schedule 03.01.2015