ライオンの顔像Autogen

要綱.

sphinx-autogen [options] <sourcefile> ...

説明する.

sphinx-autogen Sphinxソースコードを自動生成するためのツールです autodoc 拡張子、含まれる文書項目 autosummary リストです。

ソースファイル. 1つまたは複数の含まれています autosummary 有す :toctree:: オプションセット。 ソースファイル. はい一つです。 fnmatch -パターンパターン。

オプション

-o <outputdir>

出力ファイルのディレクトリを置く.もしそれが存在しなければ、それを作成するだろう。デフォルトで転送するように設定されています :toctree: 選択します。

-s <suffix>, --suffix <suffix>

生成するためのファイルのデフォルト接尾辞黙認する. rst それがそうです。

-t <templates>, --templates <templates>

テンプレートディレクトリをカスタマイズする.黙認する. None それがそうです。

-i, --imported-members

導入したメンバを記録する.

例を引く

以下のディレクトリ構造を与える：

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

各ファイルには1つが含まれます autodoc 指示と他のいくつかの情報。

また見られる.

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