Python项目API文档
项目描述
Python项目API文档。
示例
pdoc -o ./html pdoc 生成此网站： pdoc.dev/docs。
安装
pip install pdoc
pdoc 与 Python 3.8 及更高版本兼容。
用法
pdoc your_python_module
# or
pdoc ./my_project.py
运行 pdoc pdoc 查看pdoc的自身文档，运行 pdoc --help 查看命令行选项，或者查看我们托管在网上的文档副本。
特性
pdoc的主要特性是注重简洁：pdoc旨在做好一件事。
- 文档使用纯Markdown格式。
- 对类型注解和所有其他现代Python 3特性的第一类支持。
- 内置带有实时重新加载功能的Web服务器。
- 可自定义HTML模板。
- 理解numpydoc和Google风格的文档字符串。
- 无需额外依赖即可生成独立HTML输出。
内部机制...
pdoc会自动将文档字符串中的标识符链接到相应的文档。pdoc会尊重您的__all__变量（如果存在）。pdoc会遍历抽象语法树，从构造函数中提取类型注解和文档字符串。pdoc会自动尝试将类型注解字符串文字作为向前引用解析。pdoc会使用继承来解析类成员的类型注解和文档字符串。
如果您有更复杂的文档需求，我们建议使用Sphinx！
贡献
作为一个开源项目，pdoc欢迎所有形式的贡献。
pdoc与pdoc3的比较
本项目与“pdoc3”无关，“pdoc3”经常错误地假设我们的名字。以下是pdoc的原始作者@BurntSushi的引用：
我对有人拿走了我创建的项目，重新授权它，试图从Python Wiki上删除其条目，以几乎相同的方式发布它，最糟糕的是，将其与纳粹符号联系起来，感到非常厌恶。
相比之下，pdoc项目致力于维护一个健康的社区，每个人都受到尊重。只要遵守基本的礼貌，每个人都欢迎贡献。我们明确与纳粹符号和意识形态的使用保持距离。
pdoc项目最初由Andrew Gallant创建，目前由Maximilian Hils维护。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
源分布
pdoc-14.7.0.tar.gz (154.6 kB 查看散列值)
构建分布
pdoc-14.7.0-py3-none-any.whl (144.8 kB 查看散列值)
