如何在 Sphinx 中定义应该使用哪些 .rst 文件和目录?
我想在我的测试/构建/文档脚本中包含一个自动文档生成器。 sphinx-quickstart在我的工作区中执行并创建了一个 index.rst 文件。由于 Sphinx 使用重组的文本文件作为文档,我在工作区中导航并使用sphinx-autogen手动创建它们。它导致了 tasks.rst 文件(见下文)。
当我使用“make html”时,会收到几个警告:
警告:自动模块的签名无效(u'tasks/add_to_config')
警告:autodoc 无法导入/查找模块 'tasks.add_to_config',它报告错误:“没有名为 wl_build.tasks 的模块”,请检查您的拼写和 sys.path
警告:不知道要导入哪个模块来自动记录 u'tasks/add_to_config'(尝试在文档中放置“模块”或“当前模块”指令,或给出明确的模块名称)
...
我的索引.rst
Welcome to build's documentation!
====================================
Contents:
.. toctree::
:maxdepth: 2
.. automodule:: tasks/add_to_config
:members:
.. automodule:: tasks/build_egg
:members:
任务.rst
tasks Package
=============
:mod:`tasks` Package
--------------------
.. automodule:: tasks.__init__
:members:
:undoc-members:
:show-inheritance:
:mod:`add_to_config` Module
---------------------------
.. automodule:: tasks.add_to_config
:members:
:undoc-members:
:show-inheritance:
:mod:`build_egg` Module
-----------------------
.. automodule:: tasks.build_egg
:members:
:undoc-members:
:show-inheritance: