Попытка создать документацию с помощью Sphinx.
Сначала с помощью: sphinx-apidoc
Затем с помощью: sphinx-build html
И я получил это предупреждение о файле modules.rst
. Файл существует, html также сгенерирован, он определенно выглядит как таблица содержания.
Я прочитал все топи c, которые я смог найти по теме, ни один из них не решает проблему (правильное расположение модули в файле 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)
В этом топе c: Не удается заставить сфинкс ссылаться на другой документ под токтрием в сообщении об ошибке указано intro.rst
вместо modules.rst
. Изменить: как я уже сказал, я, к сожалению, уже прочитал другие темы, и они не решили мою проблему. Он все еще сломан.