自动生成Python项目的API文档。
项目描述
pdoc
自动为Python 3+项目生成API文档。
安装
$ pip install pdoc3
使用
Pdoc可以接受Python模块文件、包目录或导入路径。
$ pdoc your_project
有关更多命令行选项和用法示例，请参阅 pdoc --help 和 文档。
功能
- 简单用法。无需特殊配置即可生成合理的API（+散文）文档。
- 支持常见的文档字符串格式（Markdown、numpydoc、Google风格文档字符串）、LaTeX数学和某些reST指令。
- 支持PEP 484和PEP 526类型注解。
- pdoc在存在的情况下会尊重
__all__。 - 如果未指定，则覆盖类的成员的文档字符串将被继承。
- 通过遍历AST支持通过文档字符串记录模块、类和实例变量。
- 自动交叉链接引用的标识符。
- 通过特殊的模块级
__pdoc__字典覆盖文档字符串生成。 - 易于扩展和自定义模板。
- 内置的 开发网页服务器，可快速预览渲染的文档字符串。
以上功能在 pdoc 的 文档（由 pdoc 生成）中解释得更加详细。
开发
查看 CONTRIBUTING.md 获取黑客细节。
关闭
pdoc3-0.11.1.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 20bf2aad8110892573fd350b1bf95f6612b53b55e29b0fc143b5f2b5bcbabfb6 |
|
| MD5 | 98fe4a644f95c9ef58163484507cad5b |
|
| BLAKE2b-256 | 40a3141d32ae6abfdd17f0314a3f6b93ce83becefc7f0f71f5902b6b8b993cd7 |