[Numpy-discussion] missing doc dir in the official tarball

David Cournapeau david@ar.media.kyoto-u.ac...
Sun Dec 21 06:14:50 CST 2008


Ondrej Certik wrote:
>
> Why not to just include the *sources* together with numpy, and
> possibly include html+whatever in a separate documentation package?
>   

I don't think having separate built  doc and built package is a good
idea. It is confusing for the user, and I am afraid we won't alway keep
everything in sync. We don't need to ship all the doc of course, but at
least the pdf (or any other format, the point is to have at least one;
it could be different on different platforms for the binaries for
example). Specially for new comers, having everything in one place is
better IMHO.

I agree we should also put the doc sources together with the source
tarball: that seems to be the common practice for almost every open
source package out there. The only drawback is the tarball size, but
since we are still talking about a couple of MB max, I don't think it is
very relevant.

IOW:
    - ship the doc sources + one built format with the released source
distribution. It should not be built with sdist, but with another mean
(so that one can easily generate a source distribution).
    - ship the built doc with every binary installer.

David


More information about the Numpy-discussion mailing list