为python项目自动生成api文档。
pdoc3的Python项目详细描述
PDOC
为python项目自动生成api文档。
安装
$ pip install pdoc3
用法
pdoc将接受python模块文件、包目录或导入路径。
$ pdoc your_project
有关更多命令行开关和documentation的信息，请参见pdoc --help
更多用法示例。
功能
- 简单的用法。生成合理的api（+prose）文档，而不需要任何 特殊配置。
- 支持常见的docstrings格式（markdown、numpydoc、google样式的docstrings） 以及一些rest指令。
- 支持PEP 484类型注释。
- pdoc在存在时尊重
__all__。 - 继承用于为类成员推断docstring。
- 支持通过遍历AST记录模块、类和实例变量。
- HTML和PDF中引用标识符的自动交叉链接。
- 使用特殊模块级
__pdoc__字典重写docstrings。 - 内置开发Web服务器，用于对呈现的文档字符串进行近乎即时的预览。
以上特性在pdoc的documentation中有更详细的解释。 （由pdoc生成）。
欢迎加入QQ群-->： 979659372
