Использование self для создания карты сайта с toctree в сфинксе кажется сломанным?

Я обновляю FAQ для довольно большого проекта, и я хотел бы добавить указатель вопросов вверху страницы, чтобы пользователям было легче находить то, что они ищут.

В статье о toctree документации Sphinx говорится: «Специальное имя записи self обозначает документ. содержащий директиву toctree. Это полезно, если вы хотите сгенерировать «карту сайта» из toctree ». Это то, что я хочу. Проблема в том, что self кажется сломанным и включает только текущий заголовок документа, а не субтитры. Он работает правильно, когда я нахожусь в другом документе и ссылаюсь на FAQ, только в самом документе он терпит неудачу.

Демонстрировать

.. toctree::
   :maxdepth: 3

   faq

В другом файле приводит к

  • Frequently Asked Questions
    • FAQ
      • Question 1
      • вопрос 2
      • Вопрос 3
    • Неочевидное поведение и прочее, что нужно знать

Внутри faq

.. toctree::
   :maxdepth: 3

   self

приводит к

  • Часто задаваемые вопросы

Я подумал, что, возможно, это произошло из-за того, что сфинкс не знал о субтитрах при преобразовании токтрия и пытался переместить токтри в нижнюю часть страницы. Без изменений.

Мы будем очень благодарны за любые идеи о том, как включить индекс страницы на самой странице с помощью sphinx.


sections tableofcontents python-sphinx toctree
person Damgaard    schedule 21.04.2013    source источник

Ответы (1)


arrow_upward
9
arrow_downward

Вам нужна директива content.

Вставьте следующий блок после заголовка своей страницы, чтобы составить список вопросов:

.. contents::
   :local:
   :depth: 1

Он будет производить:

  • Вопрос 1
  • вопрос 2
  • Вопрос 3
person Thomasleveil    schedule 20.07.2013