通过PyPi的pip安装库包含示例和文档

时间:2019-01-07 00:42:18

标签: python pip pypi

我在PyPi上注册了一个库,可以通过pip安装。使用manifest.in文件,我将docs目录和examples目录捆绑在一起。 PyPi上的“源归档”压缩文件具有此内容,但是当我执行传统的pip安装时,不包含这些内容(至少看起来不是这样,在站点软件包目录中查找)。

最佳做法是什么?没有文档和/或示例?要将它们放入安装setup.py的软件包中?除了站点软件包之外,还有其他途径可以将这些东西安装到其他地方吗?

1 个答案:

答案 0 :(得分:0)

您首先在MANIFEST.in文件中指定文件(相对路径或全局文件),然后将include_package_data=True添加到setup.py中。然后,在安装软件包时,文件将被复制到site-packages

但是我认为将文档发布到RTD并从自述文件链接到RTD更为常见。参见:https://readthedocs.org/