これは、Ubuntu Online、Fedora Online、Windows オンライン エミュレーター、MAC OS オンライン エミュレーターなどの複数の無料オンライン ワークステーションの XNUMX つを使用して、OnWorks 無料ホスティング プロバイダーで実行できるコマンド sphinx-apidoc です。
プログラム：
NAME
sphinx-apidoc - Sphinx API ドキュメント生成ツール
SYNOPSIS
スフィンクス-アピドック [オプション] -o出力ディレクトリ>>ソースディレクトリ> [パス名 ...]
DESCRIPTION
スフィンクス-アピドック autodoc を使用して Sphinx ソースを自動生成するツールです。
拡張機能。他の自動 API ドキュメントのスタイルでパッケージ全体をドキュメント化します。
ツール。
ソースディレクトリ Python パッケージを指す必要があります。 どれでも パス名 除外されるパスが指定されています
世代からして。
警告：
スフィンクス-アピドック を使用するソース ファイルを生成します。 sphinx.ext.autodoc 見つかったすべてを文書化する
モジュール。 インポート時にモジュールに副作用がある場合、それらは次によって実行されます。 オートドック
を特定いたします。 スフィンクスビルド 実行されます。
(ライブラリ モジュールではなく) スクリプトを文書化する場合は、そのメイン ルーチンを確認してください。
によって保護されています if __名前__ == '__主要__' 条件。
OPTIONS
-o
出力ファイルを配置するディレクトリ。 存在しない場合は作成されます。
-f, - 力
通常、このオプションが指定されていない限り、apidoc はファイルを上書きしません。
-l, -- リンクをたどる
シンボリックリンクをたどります。
-n, -ドライラン
指定した場合、apidoc はファイルを作成しません。
-s
生成されたソース ファイルのサフィックス。デフォルトは 最初の.
-d
生成される目次ファイルの最大の深さ。
-T, --no-toc
目次ファイルは作成しないでください。
-F, - 満杯
指定すると、完全な Sphinx プロジェクトが生成されます (conf.py, メークファイル など）を使用して
スフィンクスのクイックスタート。
-e, - 分ける
各モジュール ファイルを独自のページに配置します。
-E, --見出しなし
モジュール/パッケージの見出しを作成しないでください
-P, - プライベート
「_private」モジュールを含める
これらのオプションは一緒に使用されます -F:
-H
構成に含めるプロジェクト名。
-A
構成に含める作成者名。
-V
プロジェクトのバージョン。
-R
プロジェクトのリリース。
onworks.net サービスを使用してオンラインで sphinx-apidoc を使用する
