[Python-Dev] Python documentation

[Barry Warsaw]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Sep 21, 2008, at 6:03 AM, Georg Brandl wrote:

> Barry Warsaw schrieb:
>> Martin points out that in the past, as part of the release process,
>> we've built separate downloadable documentation.
>>
>> Do we still want to do that for Python 2.6 and 3.0, and if so, how do
>> we go about doing that?  I have this feeling that building the
>> documentation is much different now than in the past, and I don't
>> really have a good feel for how it's done now.
>>
>> If you think we should release separate downloadable documentation  
>> and
>> can help integrate that into the release project, you just might be a
>> Documentation Expert <wink>.  Please let me know if you can help.
>
> There is almost everything ready for doing this. There is a "download"
> page in the HTML docs (that at the moment contains nothing).
>
> If you tell me where the downloadable files will be on python.org, I  
> can
> add them to the "download" page and you only need to build the docs  
> and
> put them in that location. I've just added a "dist" target to the Doc/
> Makefile, so a "make dist" should place all needed files in the Doc/ 
> dist
> directory, from where you can copy them to the desired location.

Benjamin has hacked on the release.py script to build and sign the  
documentation.  I haven't tried it yet but it looks like it does a  
'make html' and exports that.

Given the above, we should change that to 'make dist' and update the  
PEP to describe scp'ing them to dinsdale:/ftp/python/doc/X.Y using the  
templates on this page: http://docs.python.org/download.html

I notice that for 2.5, we zip'd and tar-bz2'd them.  Do we want to  
also support tgz?  We'll have to hack the release script to build the  
doc zips.  I'll try to test drive this whole process soon.

Thanks!
- -Barry

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Darwin)

iQCVAwUBSNYvAXEjvBPtnXfVAQKj/QQApu2YzQLZfpazIb6jPxtWDMnpW99+TrRP
miMEwURQmncYWIK1kt9RuBpjszjKKw5x/pP9DEy7Slx+AQq13q1U2Ddi8yQmvWGk
Sf3rRxBbgG8QM5H67toB/T6kDtti8C0F0OZZFZpG83nAVZuwtomw7ZYZS2P5Qzq+
eZnW5aANX4g=
=HF5j
-----END PGP SIGNATURE-----