[Distutils] Including documentation in distribution?

Johan Ekh ekh.johan at gmail.com
Fri Feb 11 11:28:41 CET 2011

Thank you for your answer!

Sorry for not being clear. This is the first time I need to send my
developed software to other people.

So, let me explain what I want to do.
I have the directory structure above, and in addition my MANIFEST.in
contains one single row:

recursive-include doc/build/html *

I have added the "package_dir = {'':'src'}" to my setup.py as you suggested.

I am still working with my code under "src" and with the documentation under
"doc". I'm on a linux computer.

I need to send my code to windows users. They have Python installed. They
need to run my program
from the commandline in windows. I also would like my html documentation to
be placed in some reasonable
place on their computers.

I would like to easily make a system wide installation of my code and
documentation on my own linux machine.
I need a running version while I continue to develop the software.

What is the best strategy to do this?

Best regards,

On Thu, Feb 10, 2011 at 6:42 PM, P.J. Eby <pje at telecommunity.com> wrote:

> At 05:20 PM 2/10/2011 +0100, Johan Ekh wrote:
>> my setup.py looks like
>> #!/usr/bin/env python
>> from setuptools import setup, find_packages
>> setup(name='cabletlk',
>>      version='0.1',
>>      description='Cable Toolkit',
>>      author='Johan Ekh',
>>      author_email='<mailto:johan.ekh at se.abb.com>johan.ekh at se.abb.com',
>>      packages=['mypkg',],
>>      )
> It looks like you're missing a:
>   package_dir = {'':'src'}
> from that.
>  I would like to include the content in "doc/built/html" in my
>> distribution.
>> How can I do that?
> If you mean your source distribution, you can do that by putting those
> files in revision control (w/appropriate plugin), or by adding appropriate
> directives to a MANIFEST.in file (see the distutils documentation for
> If you mean you want to install the docs as data in a certain path for
> specific platforms, see the distutils documentation for the "install_data"
> command.
> If you want to include the docs in an .egg distribution or installation,
> you'll need to place them either under your .egg-info directory, or else put
> them inside mypkg/ and use include_package_data=True or the package_data={}
> directives.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20110211/ab1fd911/attachment-0001.html>

More information about the Distutils-SIG mailing list