如何在sphinx中定義哪些.rst文件和目錄應該被使用?Python:我如何在獅身人面像中定義哪些.rst文件和目錄應該被使用?
我想在我的測試/建築/文檔腳本中包含一個自動文檔生成器。 sphinx-quickstart在我的工作區執行並創建了一個index.rst文件。由於獅身人面像使用重組文本文件作爲文檔,我通過工作區導航並使用sphinx-autogen手動創建它們。它導致了tasks.rst文件(見下文)。
當我使用 '做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: