Python pip - 安装包的文档？

Posted 2023-03-07

【中文标题】Python pip - 安装包的文档？

【英文标题】：Python pip - install documentation for packages?

【发布时间】：2011-05-10 04:20:37

【问题描述】：

有没有办法为使用 pip 安装的包安装/生成文档？

我希望安装项目所需的所有包，以及所有相关文档（例如，安装 django 时的 Django 文档、带有 dateutil 的 dateutil 文档等）。

Pip 需求文件是快速安装项目所需包的好方法，但如果我也可以安装所有相关文档会更好。

Ubuntu Python 软件包将文档安装到 /usr/share/docs，但 pip 似乎没有这样做。

当我需要离线处理项目时，这些包的文档对我来说很重要。

【问题讨论】：

我不知道从 pip 下载它，但是很多开发人员都支持 epydoc，您可以使用它来自动生成文档。

【参考方案1】：

我认为您正在寻找与 ruby​​ 自动（除非被抑制）从已安装的 gems/packages 生成 rdoc 的方式等效的方法。

在 python 中，有一个标准化的机制来用文档注释代码 -- docstrings 和 optional formatting。但是，没有从 python 代码生成/存储文档的标准化方法。每个 python 包可能有不同的机制，因此 pip 无法生成它。