安装Python包文档

Question

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

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

Python世界中是否存在将API文档与包一起安装的约定？或者通常假设文档仅在线提供？

欢迎任何想法，谢谢！

Answer 1

distutils不支持安装文档。现在，在线发布它们似乎比在目标系统上安装它们更重要，所以如果你设置使用Reat The Docs或将文档上传到PyPI，你就是好的。