Skip to main content
 首页 » 编程设计

python之安装 Python 包文档

2025年05月04日11youxin

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

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

在 Python 世界中是否有将 API 文档与包一起安装的惯例?或者通常认为文档只能在线获取?

欢迎任何想法,谢谢!

请您参考如下方法:

distutils 不支持安装文档。如今,在线发布它们似乎比将它们安装在目标系统上更重要,所以如果您设置为使用 Rat The Docs 或将文档上传到 PyPI,那很好。