Отсутствует пустая строка между директивой и ошибкой записей

Я только что создал свою документацию с помощью Sphinx, и это моя проблема: сначала директива Toc tree пуста, а затем я добавляю «учебник» ниже, и это выглядит так:

.. toctree::
   :maxdepth: 2
    tutorial

и когда я «делаю html», я не получаю «учебник» на странице индекса. Затем я создал tutorial.rst в том же каталоге, что и index.rst. Я снова делаю "make html" и получаю следующее сообщение об ошибке:

toctree содержит ссылку на несуществующий документ

Как это исправить ?


python-sphinx toctree
person Simon    schedule 23.04.2013    source источник

Ответы (2)


arrow_upward
5
arrow_downward

Может попробовать это:

.. toctree::
   :maxdepth: 2

   tutorial <tutorial>

..

Предположим, что ваш файл tutorial.rst находится в «исходном» каталоге на том же уровне, что и ваш файл index.rst.

ПРИМЕЧАНИЕ: новая строка важна между параметрами toctree и списком страниц.

person lpa    schedule 23.04.2013
comment
Это работает. Официальная документация (sphinx-doc.org/en /stable/markup/toctree.html#toctree-directive) неправильно? - person xtian; 11.02.2018

arrow_upward
-2
arrow_downward

Между определением maxdepth и именем файла должна быть пустая строка.

person Martin Wahogo    schedule 22.02.2018