nb autodoc

nb-autodoc

単純化された中国語の英語

導入

NB-Autodocは、Pythonソースコードタイプの注釈とドキュストリングからAPIドキュメントを自動的に生成するツールです。

このツールは、パッケージからすべてのモジュールを見つけてインポートし、各モジュールの抽象的な構文ツリー、ランタイムタイプを解析し、内部オブジェクトをリンクし、機能シグネチャを解析し、最後に完全で信頼性のあるリンクベースのAPIドキュメントを生成します。

主な機能

• ASTベースのタイプ分析システム

• X | Yなどの最新のジャンルディスプレイX | Y 、 list[str] 、 (*args) -> Any

• スタブ（.pyi）サポート

• type_checkingサポート

• サポートの再輸出、ASTからのリファレンスをインポートします

• 過負荷の過負荷機能サポート

使用法

PIPからのインストール：

 pip install nb-autodoc

nb-autodocを実行：

 nb-autodoc {package_name}

その他のコマンドラインオプション：

 Usage: nb-autodoc [OPTIONS] MODULE

Options:
  -o, --output-dir DIRECTORY      [default: build]
  -s, --skip TEXT                 skip import modules
  -u, --undoc TEXT                undocument modules
  --markdown-linkmode [heading_id|vuepress]
                                  [default: heading_id]
  --help                          Show this message and exit.

ヒント： --skipの代わりに--undoc使用します。これにより、モジュールのインポートと分析がスキップされます。