[Distutils] Best practices on distributing documentation and examples with eggs?

Dave Peterson dpeterson at enthought.com
Thu Jul 26 10:02:02 CEST 2007


Over on the enthought-dev mailing list we're having a bit of a 
discussion on what the best way to distribute documenation and examples 
is for projects that we distribute binary eggs for.   The general 
consensus is that it would be very nice indeed if there was a way to 
generate a tarball, or platform install, of just documentation and 
examples so that people wouldn't need to download a full, presumably 
significantly larger, source tarball.   Another option would be that 
eggs included the documentation and examples and that, during the 
installation of the egg, those docs and examples were relocated to a 
common location (outside of the zip) to make access by users more 
convenient.  This latter idea is similar to how Ruby Gems deal with docs.

I don't claim to be a distutils or setuptools guru, so it shouldn't be 
too surprising that I can't seem to find anything about a setuptools or 
distutils command to do either of these.   Am I missing something?

If not, does it seem like something that might be worthy of putting into 
setuptools?


-- Dave


More information about the Distutils-SIG mailing list