python - 包含来自 PyPi 的 pip 安装库的示例和文档

Question

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

对此的最佳实践是什么？没有文档和/或示例？将它们放入 setup.py 安装的包中？除了站 pip 包之外，还有其他途径可以将这些东西安装到其他地方吗？

Answer 1

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

但我认为更常见的做法是仅将文档发布到 RTD 并从自述文件中链接到它们。请参阅:https://readthedocs.org/