[Distutils] docs/ vs doc/

Barry Warsaw barry at python.org
Tue Sep 21 16:34:24 CEST 2010

On Sep 21, 2010, at 05:20 PM, anatoly techtonik wrote:

>On Tue, Sep 21, 2010 at 2:57 PM, Barry Warsaw <barry at python.org> wrote:
>>>I see that distutils2 promotes storing documentation in docs/
>>>directory while Python sources use Doc/
>>>I'd like to see this changed before distutils2 is released beta.
>> What does "promotes" mean?  That only docs/ can be used?
>upload_docs command will extract documentation from 'docs/' by
>default. I wouldn't bring this question if it could also process
>'doc/' in cases where 'docs/' are absent. You can specify upload
>directory explicitly, but sometimes you'd really like it to just work.

Gotcha, thanks.

Yes it should definitely use doc/ if docs/ is missing.  However, upload_docs
never quite works out of the box for me anyway.  First, it insists on an
index.html file, which my Sphinx builds never seem to write, so I always have
to add a symlink.  Second, it doesn't seem to play nicely with the location
that my buildout-based builds puts the docs, so I always also have to use
--upload-dir.  Yes, it would be nice if both of these problems were fixed too.
Yes, I should report them as bugs (or just fix 'em ;).

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: not available
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20100921/7fe3b77c/attachment.pgp>

More information about the Distutils-SIG mailing list