-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 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. - -Barry -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.9 (Darwin) iQCVAwUBSNOLBnEjvBPtnXfVAQIQnAQAm6thEThGufep6hzHxBwAN8MTsLb9jxsu Z8GAtX1bdMNOrJczYpU6by0oXPLR2pupnGV1YrAyQyoqpk+K7W8by5Qtg8+ZZcYH GerkqMVtNYn2zY1HhKigivp2JvlqIidRc5D36XS2EJixhZEPcOQDVm34THNQyRJT QasCQwdSAHI= =MbMY -----END PGP SIGNATURE-----
On Sep 19, 2008, at 7:20 AM, Barry Warsaw wrote:
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, ...?
Yes, I think so. The downloads are very useful for people who regularly work disconnected from the public internet, or who are constrained by very small pipes. The PDF downlaods are also pretty important for the smaller documents, especially the tutorial. Many people want to walk away from the computer to read through that the first time.
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.
I think we should, but I'm hoping Georg has some ideas on how best to get the processes integrated. :-) -Fred -- Fred Drake <fdrake at acm.org>
+1. I find the offline versions to be vital. Sent from my iPhone On Sep 19, 2008, at 12:20 PM, Barry Warsaw <barry@python.org> wrote:
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
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.
- -Barry
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.9 (Darwin)
iQCVAwUBSNOLBnEjvBPtnXfVAQIQnAQAm6thEThGufep6hzHxBwAN8MTsLb9jxsu Z8GAtX1bdMNOrJczYpU6by0oXPLR2pupnGV1YrAyQyoqpk+K7W8by5Qtg8+ZZcYH GerkqMVtNYn2zY1HhKigivp2JvlqIidRc5D36XS2EJixhZEPcOQDVm34THNQyRJT QasCQwdSAHI= =MbMY -----END PGP SIGNATURE----- _______________________________________________ Python-Dev mailing list Python-Dev@python.org http://mail.python.org/mailman/listinfo/python-dev Unsubscribe: http://mail.python.org/mailman/options/python-dev/python%40rcn.com
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. Georg -- Thus spake the Lord: Thou shalt indent with four spaces. No more, no less. Four shall be the number of spaces thou shalt indent, and the number of thy indenting shall be four. Eight shalt thou not indent, nor either indent thou two, excepting that thou then proceed to four. Tabs are right out.
-----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-----
On Sep 21, 2008, at 7:24 AM, Barry Warsaw wrote:
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.
We specifically decided to drop .tgz since it didn't really make sense to have both .tgz and .tar.bz2, and the software to handle .tar.bz2 is widely deployed. -Fred -- Fred Drake <fdrake at acm.org>
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.
In addition to the creation of downloadable scripts, there should also be a copy of the documentation online, at http://www.python.org/doc/2.6/ http://www.python.org/doc/3.0/ In addition, some documentation set should show up at http://docs.python.org/ Not sure whether this should be 2.6 or 3.0. Regards, Martin
On Sun, Sep 21, 2008 at 2:12 PM, "Martin v. Löwis" <martin@v.loewis.de> wrote:
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.
In addition to the creation of downloadable scripts, there should also be a copy of the documentation online, at
http://www.python.org/doc/2.6/ http://www.python.org/doc/3.0/
In addition, some documentation set should show up at
Not sure whether this should be 2.6 or 3.0.
Almost certainly 2.6. -- Cheers, Benjamin Peterson "There's no place like 127.0.0.1."
Benjamin Peterson wrote:
On Sun, Sep 21, 2008 at 2:12 PM, "Martin v. Löwis" <martin@v.loewis.de> wrote:
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. In addition to the creation of downloadable scripts, there should also be a copy of the documentation online, at
http://www.python.org/doc/2.6/ http://www.python.org/doc/3.0/
In addition, some documentation set should show up at
Not sure whether this should be 2.6 or 3.0.
Almost certainly 2.6.
Definitely 2.6 - 2.x is still going to be the "mainstream" Python version for a good while yet. Although it may be worth tweaking the main index page for the 2.6 docs to include a cross-link to the 3.0 docs. Cheers, Nick. -- Nick Coghlan | ncoghlan@gmail.com | Brisbane, Australia --------------------------------------------------------------- http://www.boredomandlaziness.org
Nick Coghlan wrote:
Benjamin Peterson wrote:
On Sun, Sep 21, 2008 at 2:12 PM, "Martin v. Löwis" <martin@v.loewis.de> wrote: [...]
In addition, some documentation set should show up at
Not sure whether this should be 2.6 or 3.0. Almost certainly 2.6.
Definitely 2.6 - 2.x is still going to be the "mainstream" Python version for a good while yet.
Although it may be worth tweaking the main index page for the 2.6 docs to include a cross-link to the 3.0 docs.
Indeed. Having spent efforts to persuade the community that 3.0 isn't intended to replace 2.6 for production use it would be a shame to have docs.python.org counteract that. regards Steve -- Steve Holden +1 571 484 6266 +1 800 494 3119 Holden Web LLC http://www.holdenweb.com/
Barry Warsaw schrieb:
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've now completed the download page for the new docs. The file names it expects are currently http://docs.python.org/ftp/python/doc/$version/python-docs-$format.$ext which is what "make dist" generates. If you want to have the version in the filename as well, use "make dist DISTVERSION=2.6" and I'll adapt the download page accordingly.
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.
As Fred says, bz2 should suffice. gzip offers no compression advantage over zip either. I've also dropped the PostScript download versions; I see no compelling reason to use them instead of PDF. Georg -- Thus spake the Lord: Thou shalt indent with four spaces. No more, no less. Four shall be the number of spaces thou shalt indent, and the number of thy indenting shall be four. Eight shalt thou not indent, nor either indent thou two, excepting that thou then proceed to four. Tabs are right out.
participants (8)
-
"Martin v. Löwis" -
Barry Warsaw -
Benjamin Peterson -
Fred Drake -
Georg Brandl -
Nick Coghlan -
Raymond -
Steve Holden