cpython/Doc
Fred Drake 031ad4b2a0 \mytableofcontents New macro. Wrapper around \tableofcontents that
does the right thing if the openright option is given.  Allows a
	lot of crud to be removed from the document files' frontmatter
	sections.

\endabstract		Extend standard macro.  (Called as \end{abstract}.)
	Does the right thing if the openright option is given.

\optional		Adjust to get the brackets right under latex2e.
1998-01-09 05:34:23 +00:00
..
api Descriptions for PyRun_String(), PyRun_File(), and PyRun_CompileString() all 1998-01-02 03:24:19 +00:00
ext Added pointer to api.tex and note about the out-of-date-ness of this 1997-10-07 14:40:16 +00:00
html Simple index for the reference manuals (mostly for use on the Windows 1997-11-25 18:27:23 +00:00
icons Adding the icons used by latex2html output to the CVS tree. 1997-11-25 20:14:07 +00:00
info Updated release date to match boilerplate.tex. 1997-12-30 04:42:49 +00:00
lib For consistency, always use a trailing "()" on function names in the running 1998-01-08 04:00:30 +00:00
mac Reduce warning count from partparse.py. 1997-12-29 18:53:31 +00:00
ref Apply fixps.py to allow A4 paper printing. 1997-12-30 23:49:49 +00:00
templates Make the word "Module" in the section header start with an upper-case "M" 1997-12-17 13:44:37 +00:00
texinputs Set the release date for 1.5 (final). 1997-12-30 04:29:30 +00:00
tools Script to convert module index data to module index. 1998-01-02 03:00:27 +00:00
tut Took out some disclaiming text (even from the title!). Rewritten 1997-12-30 04:40:25 +00:00
.cvsignore Ignore generated info files. 1997-12-29 21:37:21 +00:00
.latex2html-init img_tag(), top_navigation_panel(): Generate markup the same case as other 1997-12-18 14:16:46 +00:00
Makefile lib.dvi target: Added commands to generate the modules index. 1998-01-02 03:01:47 +00:00
README Updated the README to the current status. Added a note about the 1997-12-08 20:51:26 +00:00
api.tex Descriptions for PyRun_String(), PyRun_File(), and PyRun_CompileString() all 1998-01-02 03:24:19 +00:00
boilerplate.tex Set the release date for 1.5 (final). 1997-12-30 04:29:30 +00:00
copyright.tex
custlib.py
ext.tex Added pointer to api.tex and note about the out-of-date-ness of this 1997-10-07 14:40:16 +00:00
fix.el Change name of temporary file to avoid possible filesystem issues; matches 1997-12-29 16:58:46 +00:00
fix_hack
fix_libaux.sed
index.html Simple index for the reference manuals (mostly for use on the Windows 1997-11-25 18:27:23 +00:00
keywords.py
lib.tex Add module index before the general index. 1998-01-02 02:59:09 +00:00
libaifc.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libal.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
liballos.tex Adding Martin von Loewis' documentation for his locale module. 1997-11-20 21:04:27 +00:00
libamoeba.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libanydbm.tex Added \indexsubitem definition. Non-optimal, but two modules are sharing 1997-11-30 05:38:44 +00:00
libarray.tex Added missing "\" to "\var{address}, var{length}" in buffer_info() description. 1997-12-29 19:33:45 +00:00
libaudioop.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libbase64.tex Fixed index entries to be more consistent. 1998-01-07 03:47:10 +00:00
libbasehttp.tex Added Greg Stein's docs for BaseHTTPServer.py. 1997-12-29 20:01:55 +00:00
libbastion.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libbinascii.tex Make the word "Module" in the section header start with an upper-case "M" 1997-12-17 13:45:50 +00:00
libbltin.tex Used a named target to form the reference to the Built-in Functions section. 1997-12-16 04:06:06 +00:00
libcd.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libcgi.tex Mark file names with \file{} instead of \code{}. 1997-12-09 03:28:42 +00:00
libcmath.tex Fixed up formatting, added descriptions for previously undocumented functions. 1997-09-30 20:14:50 +00:00
libcode.tex Nit adjustments to remove warnings when processed with partparse.py. 1997-12-29 18:21:37 +00:00
libcommands.tex Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 13:51:08 +00:00
libcopy.tex Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libcrypt.tex Normalized the word "Unix" to "\UNIX{}". 1997-12-29 17:31:22 +00:00
libcrypto.tex Replace unprotected tilders by \~ -- an unprotected tilde is a 1997-12-18 16:28:56 +00:00
libctb.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libdbm.tex Fixed index module reference. 1997-12-16 04:08:24 +00:00
libdis.tex Reduce warning count from partparse.py. 1997-12-29 20:02:55 +00:00
liberrno.tex Added doc for errorcode dictionary. 1997-11-18 15:27:51 +00:00
libexcs.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
libfcntl.tex Fixed index references to modules. 1997-12-15 22:23:52 +00:00
libfl.tex Reduce warning count from partparse.py. 1997-12-29 20:28:33 +00:00
libfm.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libfnmatch.tex Add a note that up to 1.4, translate() produced Emacs style syntax; in 1997-12-30 04:43:36 +00:00
libformatter.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libftplib.tex Added index items for the RFC and the protocol itself. 1998-01-07 13:13:42 +00:00
libfuncs.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
libgdbm.tex Fixed index module reference. 1997-12-16 04:08:24 +00:00
libgetopt.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
libgl.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libglob.tex Changed some \verb\...\ markup to the more common \code{...}. \verb\...\ is 1997-12-29 15:55:10 +00:00
libgopherlib.tex Added index entry for the protocol. 1998-01-07 13:17:20 +00:00
libgrp.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
libgzip.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
libhtmllib.tex Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libhttplib.tex Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libimageop.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libimgfile.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libimghdr.tex Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 14:01:52 +00:00
libimp.tex Normalize some markup. 1998-01-07 18:57:01 +00:00
libintro.tex
libjpeg.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libkeyword.tex Documentation for the keyword module. 1997-10-06 21:39:16 +00:00
liblocale.tex Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 15:30:07 +00:00
libmac.tex Added some module references to the index. 1997-12-15 21:40:15 +00:00
libmacconsole.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmacdnr.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmacfs.tex Added missing "\end{funcdesc}" after FindFolder documentation. 1997-08-22 13:45:13 +00:00
libmacic.tex Reduce warning count from partparse.py. 1997-12-29 18:53:31 +00:00
libmacos.tex Reduce warning count from partparse.py. 1997-12-29 18:53:31 +00:00
libmacostools.tex Make the word "Module" in the section header start with an upper-case "M" 1997-12-17 14:01:31 +00:00
libmacspeech.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libmactcp.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libmacui.tex Make the word "Module" in the section header start with an upper-case "M" 1997-12-17 14:12:31 +00:00
libmailbox.tex Misc Mac mods by Jack. Added libmacic.tex, and these patches: 1997-08-18 15:14:26 +00:00
libmailcap.tex Changed all \verb\...\ markup to either \code{...} or \samp{...}. 1997-12-29 16:55:50 +00:00
libmain.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmarshal.tex Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libmath.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libmd5.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmimetools.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmimify.tex Documented mime_decode_header() and mime_encode_header(). 1997-08-14 14:13:01 +00:00
libmisc.tex
libmm.tex
libmods.tex
libmpz.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libni.tex Added more warnings about ni's demise. 1997-12-09 15:03:41 +00:00
libnntplib.tex Fixed up index entries. 1998-01-07 13:23:32 +00:00
libobjs.tex
liboperator.tex Remove unneeded "{}" that confused makeinfo. 1997-12-29 17:11:55 +00:00
libos.tex Added os.altsep; this is '/' on DOS/Windows, and None on systems with 1997-08-29 22:37:44 +00:00
libpanel.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libparser.tex Removed leading comment about this being "introductory" documentation; 1997-11-25 04:04:00 +00:00
libpdb.tex Small wording change about global and local trace functions. 1997-10-27 19:57:20 +00:00
libpickle.tex Clarify that __getinitargs__ is called at pickle time! 1997-12-30 17:44:48 +00:00
libposix.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
libposixfile.tex Convert a couple of three-column tables with an empty third column to 1997-12-23 04:21:20 +00:00
libppath.tex Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libpprint.tex Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 14:07:25 +00:00
libprofile.tex Removed unnecessary \small{} block; latex2html got it wrong and its no 1997-12-23 04:03:26 +00:00
libpwd.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
libpython.tex Add description for some modules that have been added since this intro 1997-11-20 21:03:33 +00:00
libqueue.tex Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 14:08:01 +00:00
libquopri.tex Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:53:22 +00:00
librand.tex Updated \indexsubitem; functions had been indexed for the wrong module. 1997-11-30 05:23:47 +00:00
librandom.tex Added "docs" for Pareto and Weibull distributions. 1997-12-30 17:38:05 +00:00
libre.tex In description of \D, revise markup so that the caret shows up in the HTML 1998-01-06 15:46:21 +00:00
libregex.tex In description of the group() method, fix markup of "\(" and "\)" literals; 1998-01-02 02:50:13 +00:00
libregsub.tex Add obsolescence note. 1997-12-30 04:54:47 +00:00
libresource.tex Use tableii environment for the table instead of tabular. This makes it 1997-12-29 19:02:01 +00:00
librestricted.tex
librexec.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
librfc822.tex Index the RFC822 reference (some other RFC references were alreaddy indexed). 1997-12-16 15:19:47 +00:00
librgbimg.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
librotor.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libselect.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libsgi.tex
libsgmllib.tex Fixed index references to modules. 1997-12-15 22:20:33 +00:00
libshelve.tex Fixed index references to modules. 1997-12-15 21:59:33 +00:00
libsignal.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libsite.tex Fixed index references to modules. 1997-12-15 22:09:42 +00:00
libsocket.tex Fix a little mess (Likecode{...} -> Like \code{...}) in recently added text. 1997-12-09 19:47:24 +00:00
libsocksvr.tex Fixed unresolved reference problem; this module wasn't \label{}ed. 1997-12-04 14:36:52 +00:00
libsomeos.tex Add description for Queue; fix typo (whichdbm should be whichdb). 1997-11-20 21:00:03 +00:00
libsoundex.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libstat.tex Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 14:11:18 +00:00
libstd.tex
libstdwin.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libstring.tex Fixed index module reference. 1997-12-16 04:04:25 +00:00
libstrings.tex
libstrio.tex Note that getvalue() must be called before close(). 1997-07-17 16:29:04 +00:00
libstruct.tex Fixed index module reference. 1997-12-16 04:08:24 +00:00
libsun.tex Fixed index module reference. 1997-12-16 04:08:24 +00:00
libsys.tex Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libsyslog.tex Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:27:26 +00:00
libtempfile.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libtemplate.tex Make the word "Module" in the section header start with an upper-case "M" 1997-12-17 13:44:37 +00:00
libtermios.tex Replace unprotected tilders by \~ -- an unprotected tilde is a 1997-12-18 16:28:56 +00:00
libthread.tex Updated platform specific notes (it is now more common to have this) 1997-08-14 19:51:26 +00:00
libtime.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libtraceback.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libtypes.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
libtypes2.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libundoc.tex Added ConfigParser.py to list of undocumented miscellaneous useful utilities. 1997-12-30 04:41:56 +00:00
libunix.tex
liburllib.tex Fixed index references to modules. 1997-12-15 22:13:50 +00:00
liburlparse.tex Reduce warning count from partparse.py. 1997-12-29 19:09:37 +00:00
libuser.tex Oops, ".pythonrc.py" should *always* be marked with \file{}; one occurrance 1997-12-16 14:43:37 +00:00
libuserdict.tex Fix a typo (the word "a" was spelled "c"!). 1998-01-07 22:05:25 +00:00
libwhichdb.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libwhrandom.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libwww.tex Added BaseHTTPServer to table of contents for chapter. 1997-12-30 23:42:27 +00:00
libxdrlib.tex For consistency, always use a trailing "()" on function names in the running 1998-01-08 04:00:30 +00:00
libxmllib.tex Make "{" and "}" in code sample visible instead of a group (it's supposed to 1997-12-29 19:59:38 +00:00
libzlib.tex Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
modindex.py Script to convert module index data to module index. 1998-01-02 03:00:27 +00:00
myformat.perl Nit. 1998-01-09 05:22:44 +00:00
myformat.sty \mytableofcontents New macro. Wrapper around \tableofcontents that 1998-01-09 05:34:23 +00:00
partparse.py Getting uglier. But it doesn't completely bomb except for some table stuff. 1997-12-29 21:40:35 +00:00
texi2html.py
texipost.dat
texipre.dat Updated release date to match boilerplate.tex. 1997-12-30 04:42:49 +00:00
text2latex.py
tut.tex Took out some disclaiming text (even from the title!). Rewritten 1997-12-30 04:40:25 +00:00
whichlibs

README

Python main documentation -- in Latex
-------------------------------------

This directory contains the Latex sources to the Python documentation.

The Python Reference Manual is no longer maintained in Latex.  It is
now a FrameMaker document.  The FrameMaker 5.0 files (ref.book,
ref*.doc) as well as PostScript generated (ref.ps) from it are in the
subdirectory ref/.  (See ftp://ftp.adobe.com/pub/adobe/framereader for
a free reader for FrameMaker documents, for some platforms.)  Many
thanks to Robin Friedrich for the conversion of the Reference Manual
to FrameMaker and his work on its index.

If you don't have Latex, you can ftp a tar file containing PostScript
of all documents.  It should be in the same place where you fetched
the main Python distribution (try http://www.python.org or
ftp://ftp.python.org).

The following are the Latex source files:

	tut.tex				The tutorial
	lib.tex, lib*.tex		The library reference
	ext.tex				How to extend Python
	api.tex				Reference for the Python/C API

All use the style option file "myformat.sty".  This contains some
macro definitions and sets some style parameters.

You need the makeindex utility to produce the index for lib.tex.

There's a Makefile to call Latex and the other utilities in the right
order and the right number of times.  This will produce DVI files for
each document made; to preview them, use xdvi.  PostScript is produced
by the same Makefile target that produces the DVI files.  This uses
the dvips tool.  Printing depends on local conventions; at my site, I
use lp.  For example:

	make lib			# create lib.dvi and lib.ps
	xdvi lib			# preview lib.dvi
	lp lib.ps			# print on default printer


Using Times fonts
-----------------

As distributed, the Latex documents use the default Tex fonts (CMR).
These qre quite ugly.  If you have the "PSfont" Latex add-on
installed, you can produce versions using Times fonts (and Courier for
fixed text) by inserting "times," in the list of options in the
documentstyle macro in the first line of the files lib.tex, tut.tex,
ext.tex, api.tex, e.g.

	\documentstyle[twoside,times,myformat]{report}


Making HTML files
-----------------

The Latex documents can be converted to HTML using Nikos Drakos'
Latex2html converter.  See the Makefile; after some twiddling, "make
l2h" should do the trick.

For the reference manual, I use Harlequin's webmaker.  I'm not very
happy with it and hope that eventually FrameMaker will be able to
produce HTML without third party help.