pdoc:一个可以替换Epydoc 的库,可以自动生成 Python 库的 API 文档-python

时间:2024-07-08 12:49:08
【文件属性】:

文件名称:pdoc:一个可以替换Epydoc 的库,可以自动生成 Python 库的 API 文档-python

文件大小:1MB

文件格式:ZIP

更新时间:2024-07-08 12:49:08

项目文档生成

pdoc:一个可以替换Epydoc 的库,可以自动生成 Python 库的 API 文档 pdoc 是一个库和命令行程序,用于发现 Python 模块或包的公共接口。 pdoc 脚本可用于生成模块公共接口的纯文本或 HTML,也可用于运行 HTTP 服务器,为已安装的模块提供生成的 HTML。 pdoc 旨在替代未维护的 epydoc。 要查看生成的文档是什么样的,请查看 pdoc 的文档。 突出的功能包括: 支持通过遍历抽象语法来查找模块、类和实例变量的文档字符串来记录数据表示。 对于文档字符串不合适的情况(如命名元组),可以在模块中使用特殊变量 __pdoc__ 来记录公共接口中的任何标识符。 用法很简单。 只需将您的文档编写为 Markdown。 没有添加特殊的语法规则。 pdoc 尊重您的 __all__ 变量。 pdoc 将自动将文档字符串中的标识符链接到其相应的文档。 当 pdoc 作为 HTTP 服务器运行时,包之间支持外部链接。 如果源代码已更新,pdoc HTTP 服务器将缓存生成的文档并自动重新生成它。 如果可用,可以在 HTML 文档中查


网友评论