sphinx-autogen¶

概要¶

sphinx-autogen [オプション] <ソースファイル> …

説明¶

sphinx-autogen は、autodoc 拡張機能を使用して、autosummary リストに含まれる項目をドキュメント化する Sphinx ソースを自動生成するツールです。

ソースファイル は、:toctree: オプションが設定された autosummary エントリを含む 1 つまたは複数の reStructuredText ドキュメントへのパスです。ソースファイル は、fnmatch スタイルのパターンにすることができます。

オプション¶

-o <出力ディレクトリ>¶: 出力ファイルを配置するディレクトリ。存在しない場合は作成されます。デフォルトでは、:toctree: オプションに渡された値になります。

-s <サフィックス>, --suffix <サフィックス>¶: 生成されたファイルに使用するデフォルトのサフィックス。デフォルトは rst です。

-t <テンプレート>, --templates <テンプレート>¶: カスタムテンプレートディレクトリ。デフォルトは None です。

-i, --imported-members¶: インポートされたメンバーをドキュメント化します。

-a, --respect-module-all¶: モジュールの __all__ 属性のメンバーだけを正確にドキュメント化します。

--remove-old¶: 出力ディレクトリにあり、もう生成されない既存のファイルを削除します。

例¶

次のディレクトリ構造が与えられた場合

docs
├── index.rst
└── ...
foobar
├── foo
│   └── __init__.py
└── bar
    ├── __init__.py
    └── baz
        └── __init__.py

そして、docs/index.rst に次の内容が含まれていると仮定します

Modules
=======

.. autosummary::
   :toctree: modules

   foobar.foo
   foobar.bar
   foobar.bar.baz

次のコマンドを実行すると

$ PYTHONPATH=. sphinx-autogen docs/index.rst

次のスタブファイルが docs に作成されます

docs
├── index.rst
└── modules
    ├── foobar.bar.rst
    ├── foobar.bar.baz.rst
    └── foobar.foo.rst

そして、これらの各ファイルには、autodoc ディレクティブとその他の情報が含まれます。

関連情報¶

sphinx-build(1), sphinx-apidoc(1)