Sphinx toctree ТОЛЬКО на боковой панели

Я новичок в Sphinx и некоторое время искал решение этого вопроса.

Моя индексная страница сделана из index.rst, который содержит toctree. Страница отображает оглавление как в теле, так и на боковой панели. Я хотел бы показать оглавление ТОЛЬКО на боковой панели, с пробелом для ввода текста в тело каждой страницы. В частности, главное «Добро пожаловать в мое место», в настоящее время index.html и index.rst должны быть просто аннотацией, а не оглавлением.

Я пробовал это:

Welcome to My Place
==================

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Contents:

Но это удаляет TOC со страницы И боковой панели. Как я могу заставить это работать?

РЕДАКТИРОВАТЬ: вот как это выглядит, я бы хотел, чтобы TOC появлялся ТОЛЬКО на боковой панели. Screen shot


sidebar python-sphinx toctree
person FT Support    schedule 24.01.2019    source источник
comment
Sphinx 2.2.11-id64-release (95ae9a6) sphinx-build 1.8.3 Нет пользовательских тем, поэтому я предполагаю, что это sphinxdoc   -  person FT Support    schedule 25.01.2019
comment
Тема по умолчанию — алебастр. См. sphinx-doc.org/en/master/usage. /theming.html#встроенные-темы   -  person mzjn    schedule 25.01.2019
comment
Да, я использую алебастр.   -  person FT Support    schedule 25.01.2019
comment
Я не могу воспроизвести проблему с помощью Alabaster.   -  person mzjn    schedule 25.01.2019

Ответы (1)


arrow_upward
0
arrow_downward

Вы можете сделать это, включив отдельный файл для toctree и указав переменную master_doc в conf.py на этот файл.

conf.py

# ...
master_doc = "contents"
# ...rest of the document

contents.rst

.. toctree::

   example

index.rst

# Landing Page
 Welcome!
person krm    schedule 21.05.2021