16

現在急速に進化しているソース コードだけでなく、ドキュメントも維持したくありませんが、Sphinx にはイライラするほどのセットアップと構成が必要なようです。(基本的な API ドキュメントが必要なだけです。) ドキュメントを HTML として生成するすべてのパッケージ、モジュール、クラス、および関数を反復するだけの Python プロジェクト内で実行できる単一のコマンドはありませんか?

sphinx-apidoc はファイルをディレクトリに配置し、conf.py を変更して sys.path にパッケージを配置した後、「make html」を実行できますが、クラスや関数を文書化せずにパッケージとモジュールのみを一覧表示します。

ありがとう！

4

1 に答える 1

19

このsphinx-apidocツールは、モジュールのスタブを自動生成します。これは、必要な場合があります。

指示

  • autodocSphinxの構成中にモジュールが有効になっていることを確認してください。

    extensions = ['sphinx.ext.autodoc']

    Sphinx内でconf.pyトリックを行う必要があります。

  • それに応じてconf.py調整してくださいsys.path（ファイルの16〜19行目のコメントを参照してください）。

    sys.path.insert(0, os.path.abspath('/my/source/lives/here'))

  • sphinx-apidocスケルトンを生成するために実行します。

    sphinx-apidoc -o /my/docs/live/here /my/source/lives/here

  • ドキュメントを再構築します。すべてがうまくいけば、次のような警告は表示されないはずです。

    mymodule.rst：4：警告：autodocはモジュール'mymodule'をインポート/検索できません

  • これで、モジュールRSTが設定されます。

于 2013-02-26T14:16:38.027 に答える