How to include docs directory in python distribution

Question

I have a python project with the following structure:

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

I would like to include the docs directory in my distribution, but I can not seem to do that. Any pointers about how this can be done would be very helpful.

My current setup.py looks like this:

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']
     )

I tried using the package_data option but haven't been successful in including the docs directory in the distribution. Is there some other conventional way of including your docs in the distribution?

See [Adding Non-Code Files](https://python-packaging.readthedocs.io/en/latest/non-code-files.html) in the packaging docs. — phoenix, Sep 11 '18 at 16:29
What is the purpose of including the docs in the source distribution? — Michael Goerz, Nov 13 '18 at 19:10

score 49 · Accepted Answer · answered Oct 27 '11 at 23:23

49

You'll need to create a MANIFEST.in file and include some simple instructions on what extra files you want to include (See MANIFEST.in Template)

Example (to include docs dir and all files directly underneath):

include docs/*

or, to include all files in the doc dir (recursively):

recursive-include docs *

answered Oct 27 '11 at 23:23

Adam Wagner

15,469
7
52
66

8

`graft docs` should work as well as `recursive-include docs *`, right? Is there a difference? – kojiro May 23 '12 at 13:48
6

Need to add include_package_data=True in your setup.py – E.Serra Oct 17 '18 at 10:19
2

Would this retain the full subdirectory tree structure of `docs/` and also reflect that same structure in the installed package? – jxramos Jan 17 '20 at 19:09

How to include docs directory in python distribution

1 Answers1

Linked