Sphinx: modules.rst: ВНИМАНИЕ: документ не включен ни в одно дерево токтридов

Пытаюсь создать документацию с помощью Sphinx.

Первое использование: sphinx-apidoc Затем использование: sphinx-build html

И я получил это предупреждение о файле modules.rst. Файл существует, html тоже сгенерирован, он определенно выглядит как оглавление.

Я прочитал все темы, которые смог найти по этой теме, ни одна из них не решила проблему (правильное расположение модулей в файле index.rst с помощью директивы .. include:: ...)

Я не знаю, что делать, чтобы все заработало

Вот копия моего index.rst файла, может быть, вы увидите то, чего нет у меня. Сгенерированные первые файлы находятся в папке sources.

Welcome to documentation!
=====================================
    
.. toctree::
   :maxdepth: 4
   :caption: Contents:

   modules

   
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Я тоже получаю это сообщение:

..\doc\sphinx\index.rst:4: WARNING: toctree contains reference to nonexisting document u'modules'

Если я заменю модули другим документом, я получу следующее:

\doc\sphinx\index.rst:4: WARNING: toctree contains reference to nonexisting document u'opsimtest'
looking for now-outdated files... none found
pickling environment... done
checking consistency... \doc\sphinx\_apidocs\modules.rst: WARNING: document isn't included in any toctree

Таким образом, похоже, что даже если я назову другой документ в toctree, он все еще ищет modules.rst (и не видит другой документ, который, однако, был встроен в файл html)

В этой теме: Не удается заставить сфинкса ссылаться на toctree в другой документ в сообщении об ошибке указано intro.rst вместо modules.rst. Изменить: как я уже сказал, я, к сожалению, уже прочитал другие темы, и они не решили мою проблему. Он все еще сломан.


person Zangdar    schedule 09.07.2020    source источник
comment
Чтобы ваш toctree directlive работал, modules.rst должен находиться в том же каталоге, что и index.rst. Сейчас они в разных каталогах. Либо переместите modules.rst, либо измените modules на _apidocs/modules.   -  person mzjn    schedule 10.07.2020


Ответы (1)


В reST пробелы имеют значение. Директива и ее параметры должны быть отделены от содержимого пустой строкой.

.. toctree::
    :maxdepth: 4
    :caption: Contents:

    _apidocs/modules
person Steve Piercy    schedule 10.07.2020