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

时间:2014-12-22 13:47:04

标签: python installation

我正在尝试找到一种方法来安装python包其文档。 我必须在没有连接到互联网的机器上使用它,因此在线帮助不是我的解决方案。此处已发布的类似问题表明这是不可能的。你有没有办法让我更容易,因为我现在正在这样做:

  1. 下载源存档
  2. 解压缩docs文件夹
  3. 正在运行sphinx
  4. 从浏览器启动索引文件(firefox等人)
  5. 有什么想法吗?

    P.S。我对Python很陌生,所以我可能会遗漏一些东西......而且我正在使用Windows(虚拟)机器......

    编辑:

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

    1. 在我上线时,通过easy_install(或任何其他以我未知的方式)在计算机上安装软件包,然后将更改复制到我的安装到目标计算机
    2. 下载源包(包含 sphinx兼容文档)并在目标计算机上安装软件包离线
    3. 但是在任何情况下我都不知道如何以所提供的文档与模块一起安装的方式安装软件包!

      您可能知道文档的文件夹:<python-folder>/Doc在Windows上安装Python 2.78之后只包含python278.chm。所以,我希望这个文件夹还包含新安装包的文档。这将避免在互联网上查看不同软件包版本的文档以及我的特定机器设置问题。

      我目前使用的大多数软件包都提供了使用sphinx生成的文档,其源代码包中包含了脱机生成文档所需的所有文件。

      所以我正在寻找的是一个包安装程序的cli参数,就像基于unix / linux的包管理器一样。我的确期望如下: easy_install a_package --with-html-docs

1 个答案:

答案 0 :(得分:1)

以下是一些情景:

  1. 包中包含zip / tar
  2. 中包含的文档
  3. 包有-docs单独下载/安装
  4. 具有可构建文档的软件包
  5. 仅包含在线文档的软件包
  6. 没有内部文档的软件包。
  7. 在任何地方都没有文档的包。
  8. 你可以用于选项1&amp;的偷偷摸摸的技巧3是以tar或zip格式下载软件包,然后在目标机器上使用easy-install archive_name ,这将从zip或tar文件安装软件包,包括(我相信) 任何文档。您会发现在某些软件包中存在未满足的依赖项 - 这些应该在简单安装时提出错误,提及缺少的内容 - 您将需要获取这些并使用相同的技巧。

    非常方便的一些事情 - virtual-env将允许您运行免费版本的python,以便您可以获得要求并pip -d&lt; dir &GT;下载时无需安装将包存储在 dir

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

    对于只有在线文档的软件包,您可以查看是否有可下载的版本,或者是否可以抓取网页并使用pandoc之类的工具转换为有用的文件。

    在5场景中,我建议在包装上提出一张票据,说明缺少可访问的文档使其几乎无法使用并且正在运行sphinx。

    在方案6中,我建议提高票证但虚拟丢失并避免使用该包,因为如果它没有文档,它可能还有很多其他问题 - 如果你是一个包作者感到诽谤读这个然后你应该感到羞愧

    镜像/缓存PyPi

    另一个可能是拥有一个最初位于防火墙外的Linux机器或VM,运行缓存或镜像服务,例如: pipyserver,通过它安装所需的软件包以填充缓存,然后将其移动(或其缓存到另一个pip服务器),在防火墙内,然后您可以使用带有记录设置的pip来完成所有安装防火墙。另请参阅答案here