代码之家  ›  专栏  ›  技术社区  ›  BuvinJ Felix

包括从pypi安装pip库的示例和文档

  •  1
  • BuvinJ Felix  · 技术社区  · 6 年前

    我在pypi上注册了一个库,可以通过 pip . 使用A manifest.in 文件,我捆绑了一个 docs 目录和 examples 目录.pypi上的“source archive”tarball包含这些内容,但是当我执行传统的pip安装时,这些内容不包括在内(至少看起来不是这样,在site packages目录中)。

    最好的做法是什么?没有文档和/或示例?将它们放入setup.py安装的包中?除了站点包之外,是否还有其他安装此类内容的路径?

    1 回复  |  直到 6 年前
        1
  •  0
  •   Corey Goldberg    6 年前

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

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