python - 如何在 python 发行版中包含 docs 目录

Question

我有一个python项目，结构如下:

Clustering  (project name)
  clustering  (package)
    clustering.py and other modules
    tests  (sub-package)
      test_clustering.py and other such files
  docs/
  bin/

我想在我的发行版中包含 docs 目录，但我似乎不能这样做。关于如何做到这一点的任何指示都会非常有帮助。

我当前的 setup.py 如下所示:

from distutils.core import setup
setup(name='Clustering',
      version='1.0',
      description='desc',
      author='A',
      author_email='me@somemail.com',
      packages=['clustering', 'clustering.tests'],
      requires=['numpy', 'scipy'],
      scripts=['bin/predict', 'bin/verify']
     )

我尝试使用 package_data 选项，但未能成功将 docs 目录包含在发行版中。是否有其他传统方式将您的文档包含在分发中？

Answer 1

您需要创建一个 MANIFEST.in 文件并包含一些关于您想要包含哪些额外文件的简单说明(请参阅 MANIFEST.in Template)

示例(包括 docs 目录和下面的所有文件):

include docs/*

或者，包含文档目录中的所有文件(递归):

recursive-include docs *