如何安装带有文档的Python包？

Question

我正在尝试寻找一种使用其文档安装python软件包的方法。 我必须在没有互联网连接的机器上使用此功能，因此在线帮助不是我的解决方案。 这里已经发布的类似问题告诉我们这是不可能的。 在我目前正在执行此操作时，您是否看到任何使此操作更容易的方法：

1. 下载源档案
2. 提取docs文件夹
3. 运行狮身人面像
4. 从浏览器启动索引文件（firefox等）

有任何想法吗？

PS我是Python的新手，所以可能是我缺少了某些东西...而我正在使用Windows（虚拟）机器...

编辑：

我正在谈论安装软件包的两种可能方法：

1. 我在线时通过easy_install（或其他未知方式）在计算机上安装软件包，然后将对安装的更改复制到目标计算机
2. 下载源程序包（ 包含与 sphinx兼容的文档）并将程序包脱机安装到目标计算机上

但是无论如何，我都不知道将提供的文档与模块一起安装的方式来安装软件包！

您可能知道存在一个用于docs的文件夹： <python-folder>/Doc在Windows上安装Python 2.78后仅包含python278.chm 。 因此，我希望该文件夹还将包含新安装软件包的文档。 这样可以避免在互联网上查看文档以获取其他软件包版本以及我的特定机器设置问题。

我当前使用的大多数软件包都随sphinx生成的文档一起提供，其源软件包包含离线生成docs所需的所有文件。

因此，我要寻找的是用于软件包安装程序的cli参数，就像基于unix / linux的软件包管理器所常见的那样。 我确实期望像： easy_install a_package --with-html-docs 。

Answer 1

以下是一些方案：

1. 软件包的zip / tar中包含文档
2. 软件包具有-docs来单独下载/安装
3. 具有可构建文档的软件包
4. 仅具有在线文档的软件包
5. 除内部文档外没有其他文档的软件包。
6. 没有任何文档的软件包。

您可以为选项1和3使用的偷偷摸摸的技巧是将软件包下载为tar或zip，然后在目标计算机上使用easy-install archive_name ，这将从zip或tar文件中安装软件包，包括（我相信）文档。 您会发现某些软件包中有未满足的依赖项-那些应该在易于安装时出现错误并提及缺少的内容-您将需要获取这些依赖项并使用相同的技巧。

非常方便的几件事-virtual virtual-env可以让您运行免费的python版本的库，因此您可以获取需求和pip -d < dir >，而无需下载即可将软件包安装到dir中 。

您应该能够对选项2使用相同的技巧。

使用仅具有在线文档的软件包，您可以查看是否有可下载的版本或可以抓取网页，并使用pandoc类的工具来转换成有用的东西。

在5种情况下，我建议在包装上加一张票，说明缺少可访问的文档会使其几乎不可用并在上面运行狮身人面像。

在方案6中，我建议抬高罚单，但实际上错过了票证，并避免使用该软件包，因为如果没有文档，它可能还会存在很多其他问题-如果您是软件包作者，那么阅读此文章会感到诽谤，然后您应该感到should愧 。

镜像/缓存PyPi

另一个可能是让Linux盒或VM最初位于防火墙之外，运行缓存或镜像服务（例如pipyserver） ，并通过其中安装所需的软件包以填充缓存，然后将其移动（或将其缓存移至其他pip服务器） ），然后在防火墙内使用pip，并使用已记录的设置在防火墙内进行所有安装。 另请参阅此处的答案。