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

时间:2011-10-27 23:12:12

标签: python setup.py

我有一个具有以下结构的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目录包含在发行版中。是否有其他传统方式将您的文档包含在发行版中?

1 个答案:

答案 0 :(得分:22)

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

示例(包括docs dir和直接在其下的所有文件):

include docs/*

或者,包括doc dir中的所有文件(递归地):

recursive-include docs *