Python pip - 如何安装软件包文档？

Question

有没有办法为通过pip安装的包生成或安装文档呢？

我想为一个项目安装所有需要的包，同时也想把相关的文档一起安装上（比如安装django时要有django的文档，安装dateutil时要有dateutil的文档等等）。

使用pip的需求文件可以快速安装项目所需的包，但如果能同时安装所有相关的文档就更好了。

在Ubuntu系统中，Python包的文档会安装到/usr/share/docs目录下，但pip似乎没有这样做。

这些包的文档对我来说很重要，因为我有时候需要在离线状态下工作。

Answer 1

我觉得你是在寻找一种类似于Ruby自动生成文档的方式（除非被禁止），这种文档是从安装的gem或包中生成的。

在Python中，确实有一种标准的方法来给代码加上文档，这就是文档字符串（docstrings），还有可选的格式化。不过，Python并没有一个统一的方法来从代码中生成或存储文档。每个Python包可能都有不同的方式，所以pip就无法生成统一的文档了。