nb autodoc

nb-autodoc

簡體中文· English

簡介

nb-autodoc 是一個從Python 源碼的類型註解和Docstring 自動生成API 文檔的工具。

本工具從包裡查找所有的模塊並導入，解析各模塊的抽象語法樹、運行時類型，鏈接內部對象，解析函數簽名和docstring 語法樹，最終生成完整、可靠、帶有鏈接的API 文檔。

主要特性

• 基於AST 的類型分析系統

• 現代的類型展示，如X | Y 、 list[str] 、 (*args) -> Any

• stub (.pyi) 支持

• TYPE_CHECKING 支持

• Re-export 支持，從AST 解析導入引用

• Overload 重載函數支持

用法

從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.

提示:使用--undoc而不是--skip ，後者會跳過模塊的導入和分析。