安装 Python 包文档答案

【问题标题】：Installing Python package documentation安装 Python 包文档
【发布时间】：2014-06-21 10:39:54
【问题描述】：

我在内部发布了一些 Python 包，我想包含 API 文档，目前采用 .rst 形式，但将来可能会使用 Sphinx 生成的 HTML。我需要比我可以合理地放入文档字符串的更多细节（背景信息、教程示例等），所以我已经把它写出来了。

我有一个简单的基于distutils 的setup.py，我在其中提取文本文件，但我不确定将它们放在目标系统的哪个位置（我的目标是 Windows、Linux 和 Mac。）

在 Python 世界中是否有将 API 文档与包一起安装的约定？还是通常认为文档只能在线获得？

欢迎任何想法，谢谢！

【问题讨论】：

stackoverflow.com/questions/9037828/…stackoverflow.com/questions/20996235/python-help-command
谢谢！我有文档字符串，我正在运送库，而不是脚本，所以 argparse 不适用。我想包含 API 文档，但我不知道在哪里部署它 - 我在您发布的答案中没有看到任何适用的内容。
相关/重复：stackoverflow.com/questions/4183692 我猜答案是“否”？

【解决方案1】：

distutils 不支持安装文档。但如今，在线发布它们似乎比将它们安装在目标系统上更重要，所以如果你准备使用 Reat The Docs 或将文档上传到 PyPI，那么你很好。

【讨论】：

谢谢 Éric，我怀疑是这样。这些是内部库，因此不幸的是，公共存储库不是一种选择：-/
您仍然可以从使用 Sphinx 中受益，并让您的 CI 系统构建并将文档推送到内部 Web 服务器。您甚至可以使用 Read The Docs 代码来拥有一个公司范围的 RTD 实例，我们做到了！