獅子面像

要綱.

sphinx-apidoc [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN ...]

説明する.

sphinx-apidoc Sphinxソースコードを自動生成するためのツールです autodoc 拡張し，他の自動API文書ツールのスタイルでパッケージ全体を記録する.

MODULE_PATH 記録するPythonパケットの経路と OUTPUT_PATH 生成されたソースコードを置いたディレクトリである.いかなる EXCLUDE_PATTERN 与えられたのは fnmatch-style 生成から除外されるファイルおよび/またはディレクトリパターン。

警告

sphinx-apidoc 生成使用 sphinx.ext.autodoc 見つけたすべてのモジュールを記録する。どのモジュールにも副作用があればこれらのモジュールは autodoc 当たる sphinx-build 走ることです。

スクリプト(ライブラリモジュールとは反対)を記録した場合、メインルーチンが受けることを確認してください if __name__ == '__main__' 条件

オプション

-o <OUTPUT_PATH>

出力ファイルのディレクトリを置く.もしそれが存在しなければ、それを作成するだろう。

-q

標準出力に何も出力するのではなく，警告とエラーのみを標準エラーに書き込む.

-f, --force

既存に生成された任意のファイルを強制的にカバーする.

-l, --follow-links

記号に沿ってリンクする。

-n, --dry-run

いかなるファイルも作成しないでください。

-s <suffix>

生成されたソースファイルの接尾辞.黙認する. rst それがそうです。

-d <MAXDEPTH>

生成されたディレクトリファイルの最大深さ.

--tocfile

ディレクトリファイルのファイル名。黙認する. modules それがそうです。

-T, --no-toc

ディレクトリファイルの作成はご遠慮ください。以下の場合は無視する --full 提供されています。

-F, --full

Generate a full Sphinx project (conf.py, Makefile etc.) using the same mechanism as sphinx-quickstart.

-e, --separate

各モジュールの文書をそれぞれのページに置く.

バージョン 1.2 で追加.

-E, --no-headings

モジュール/パッケージのタイトルを作成しないでください。例えば、文書文字列にすでにタイトルが含まれている場合、これは有用である。

-P, --private

“_Private”モジュールが含まれています。

バージョン 1.2 で追加.

--implicit-namespaces

デフォルトの場合，sphinx-apidocはsys.path探索モジュールのみを扱う.Python 3.3の導入 PEP 420 暗黙的名前付け空間、モジュールパス構造、例えば foo/bar/module.py あるいは…。 foo/bar/baz/__init__.py (注意してください、 bar そして foo 名前空間であり，モジュールではない).

パスは、PEP−0420に従って再帰的に解釈される。

-M, --module-first

モジュール文書をサブモジュール文書の前に置く.

これらのオプションは、以下の場合に使用されます --full 指定されました：

-a

MODULE_PATHをsys.pathに付加する.

-H <project>

生成されたファイルに入れる項目名の設定(参照) project ）。

-A <author>

生成されたファイルに入れる著者の名前を設定します(参照 copyright ）。

-V <version>

生成されたファイルに入れる項目バージョンの設定(参照) version ）。

-R <release>

プロジェクトバージョンは、生成されたファイルに入れるように設定されています(参照 release ）。

プロジェクトテンプレート

バージョン 2.2 で追加: Sphinx-apidocのプロジェクトテンプレートオプション

-t, --templatedir=TEMPLATEDIR

テンプレートファイルのテンプレートディレクトリ。Apidocで生成されたsphinxプロジェクトファイルのテンプレートを修正することができます。以下のJJIA 2テンプレートファイルの使用が許可されています。

• module.rst_t

• package.rst_t

• toc.rst_t

• master_doc.rst_t

• conf.py_t

• Makefile_t

• Makefile.new_t

• make.bat_t

• make.bat.new_t

具体的には、Sphinxが提供するシステムテンプレートファイルを参照してください。 (sphinx/templates/apidoc そして sphinx/templates/quickstart ）

環境.

SPHINX_APIDOC_OPTIONS

生成されたオプションのコンマ分割リストに追加する automodule 指令する。黙認する. members,undoc-members,show-inheritance それがそうです。

また見られる.

sphinx-build(1), sphinx-autogen(1)