4

Sphinxでどの.rstファイルとディレクトリを使用するかをどのように定義できますか？

テスト/構築/ドキュメント化スクリプトに自動ドキュメントジェネレーターを含めたいです。 sphinx-quickstartが私のワークスペースで実行され、index.rst-fileが作成されました。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'（ドキュメントに「module」または「currentmodule」ディレクティブを配置するか、明示的なモジュール名を指定してみてください）

..。

私の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:
4

1 に答える 1

5

/index.rstファイルの文字をピリオド（.）に置き換えてみてください

このような：

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

Contents:

.. toctree::
   :maxdepth: 2

.. automodule:: tasks.add_to_config
   :members:

.. automodule:: tasks.build_egg
   :members:

それが役立つかどうかを確認してください。

それでもSphinxがドキュメント化するコードを見つけられない場合は、Sphinxが探しているものを見つけられるように、ファイルを変更PYTHONPATHまたは変更する必要があります。sys.pathconf.py

于 2012-12-07T16:26:28.910 に答える