Python：我如何在sphinx中定义应该使用哪个.rst文件和目录？

我如何在sphinx中定义应该使用哪个.rst文件和目录？

我想在我的测试/构建/文档脚本中包含一个自动文档生成器.
sphinx-quickstart在我的工作区中执行并创建了一个index.rst文件.由于sphinx使用重组文本文件作为文档,我在工作区中导航并使用sphinx-autogen手动创建它们.它导致了tasks.rst文件(见下文).

当我使用’make html’时,我会收到几个警告：

WARNING: invalid signature for automodule (u’tasks/add_to_config’)

WARNING: autodoc can’t import/find module ‘tasks.add_to_config’, it reported error: “No module named wl_build.tasks”, please check your spelling and sys.path

WARNING: don’t know which module to import for autodocumenting u’tasks/add_to_config’ (try placing a “module” or “currentmodule” directive in the document, or giving an explicit module name)

…

我的index.rst

Welcome to build's documentation!
====================================

Contents:

.. toctree::
   :maxdepth: 2

.. automodule:: tasks/add_to_config
   :members:

.. automodule:: tasks/build_egg
   :members:   

tasks.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:

解决方法:

尝试使用句点(.)替换index.rst文件中的/字符

像这样：

Welcome to build's documentation!
====================================

Contents:

.. toctree::
   :maxdepth: 2

.. automodule:: tasks.add_to_config
   :members:

.. automodule:: tasks.build_egg
   :members:  

看看是否有帮助.

如果Sphinx仍然无法找到要记录的代码,那么您可能需要修改您的conf.py文件中的PYTHONPATH或更改sys.path,以帮助Sphinx找到它正在寻找的内容.

标签：python,documentation,python-sphinx,restructuredtext
来源： https://codeday.me/bug/20190625/1287694.html