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='[email protected]',
      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?

What is the purpose of including the docs in the source distribution? — Michael Goerz
– Michael Goerz, Commented Nov 13, 2018 at 19:10

Adam Wagner · Accepted Answer · 2011-10-27 23:23:30Z

52

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, 2011 at 23:23

Adam Wagner

16.2k7 gold badges54 silver badges67 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

kojiro Over a year ago

graft docs should work as well as recursive-include docs *, right? Is there a difference?

E.Serra Over a year ago

Need to add include_package_data=True in your setup.py

jxramos Over a year ago

Would this retain the full subdirectory tree structure of docs/ and also reflect that same structure in the installed package?

Collectives™ on Stack Overflow

How to include docs directory in python distribution

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related