简介
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，后者会跳过模块的导入和分析。
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nb_autodoc-1.0.4.tar.gz.
File metadata
- Download URL: nb_autodoc-1.0.4.tar.gz
- Upload date:
- Size: 63.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
pdm/2.24.2 CPython/3.11.4 Linux/6.6.87.2-microsoft-standard-WSL2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
57566cc074aa46de5d367bc6406364ade87956f7d0e6e30ce5fc2af64af912a0
|
|
| MD5 |
4d2d4c79d6b503e7cb38bc76cea78173
|
|
| BLAKE2b-256 |
fc3607ffb6434e5a8554f89a5e1f405da67df8399b2f18a221199a3012e10010
|
File details
Details for the file nb_autodoc-1.0.4-py3-none-any.whl.
File metadata
- Download URL: nb_autodoc-1.0.4-py3-none-any.whl
- Upload date:
- Size: 53.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
pdm/2.24.2 CPython/3.11.4 Linux/6.6.87.2-microsoft-standard-WSL2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
68a75ee461dfc895efd5c31ced653dc7de1983605f65e701541d0eb172290032
|
|
| MD5 |
df30fcf0e391a7c606fca8470a47ac66
|
|
| BLAKE2b-256 |
3d698c46be71fab80e7fee5b474eccf2efd234d5c72022a834807d54766199ba
|
