Python 项目的 API 文档
项目描述
Python 项目的 API 文档。
例子
pdoc -o ./html pdoc生成此网站：pdoc.dev/docs。
安装
pip install pdoc
pdoc 与 Python 3.7 和更新版本兼容。
用法
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 欢迎各种形式的贡献。
另外，请随时加入我们的开发人员 Slack！
pdoc 与 pdoc3
这个项目与“pdoc3”没有关联，它经常假冒我们的名字。引用pdoc的原作者@BurntSushi：
我很反感有人拿走了我建立的项目，重新授权它， 试图删除它在 Python Wiki 上的条目，以实际上相同的名称发布它，最糟糕的是，它与纳粹符号相关联。
相比之下，pdoc 项目致力于维护一个健康的社区，让每个人都受到尊重。欢迎大家踊跃投稿，只要坚持基本文明。我们明确地远离纳粹符号和意识形态的使用。
pdoc 项目最初由Andrew Gallant创建， 目前由Maximilian Hils维护。
