From 69eb8f0f6193d6fbddf1f8c7f41803d0f6dd618b Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Tue, 30 Sep 2003 04:35:01 +0000 Subject: [PATCH] describe the commands needed to build the documetation and post it in the FTP area of python.org --- pep-0101.txt | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/pep-0101.txt b/pep-0101.txt index 803f56cdf..5b2dda295 100644 --- a/pep-0101.txt +++ b/pep-0101.txt @@ -213,7 +213,33 @@ How to Make A Release Once Fred is done, there can be no further checkins on the branch in the Doc/ directory -- not even by the RM. - Basically, if it's in Doc/, Fred will take care of it. + Building the documentation is done using the Makefile in the + Doc/ directory. Once all the external tools are installed (see + the "Documenting Python" manual for information on the required + tools), use these commands to build the formatted documentation + packages:: + + $ make clobber + ... + $ make PAPER=a4 paperdist + ... + $ make distfiles + ... + + The packages can be installed on the FTP server using commands + like these: + + $ VERSION=`tools/getversioninfo` + $ TARGET=/ftp/ftp.python.org/pub/python/doc/$VERSION + $ ssh creosote.python.org mkdir $TARGET + $ scp *-$VERSION.* creosote.python.org:$TARGET + + XXX What's needed to describe posting the documentation on the + website should be added here, or there should be a link to a + document in the python.org site management documentation. + + XXX Someone who knows how to build the HTML Help format should + add a description of that process. ___ Tim Peters grabs the HTML Help format and uses this to build the Windows installer.