Не удается получить TOCTREE в Sphinx для отображения ссылки

Я новичок в Sphinx. Я попробовал учебник, но мне не удалось создать ссылку в содержании. Ошибка, которую я получил

C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe
rence to document 'intro' that doesn't have a title: no link will be generated
C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe
rence to document 'zuhdi' that doesn't have a title: no link will be generated
writing additional files... (0 module code pages) genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 3 warnings.

Build finished. The HTML pages are in build/html.

Я создал zuhdi.rst и intro.rst в том же каталоге, что и index.rst. Как поставить титул на документы?

К вашему сведению, мой index.rst содержит следующие строки:

Contents:

.. toctree::
   :maxdepth: 2

   intro
   zuhdi

Должны ли существовать документы, чтобы я помещал ссылки в токтри? intro.rst и zuhdi.rst - это просто пустой файл.


python python-sphinx toctree
person Haikal Nashuha    schedule 29.12.2012    source источник

Ответы (1)


arrow_upward
32
arrow_downward

Вы получаете эту ошибку, потому что у вас нет заголовка в intro.rst.
Чтобы исправить это, добавьте заголовок в intro.rst. Предположим, вы хотите, чтобы заголовок был My Title, тогда заголовок можно добавить, сделав следующие две строки первыми строками intro.rst:

My Title
*********

Обратите внимание, что у вас должно быть достаточно * символов, чтобы полностью подчеркнуть заголовок, иначе вы получите еще одну ошибку, связанную с неправильным заголовком или его подчеркиванием.

person inspectorG4dget    schedule 29.12.2012
comment
My Title ======= тоже подойдет - person DJ_Stuffy_K; 28.04.2021