cpython/Doc
Fred Drake e14388c4b8 Fixed index references to modules. 1997-12-15 22:28:38 +00:00
..
api Several changes, e.g. restructuring of the intro to be closer to what 1997-11-25 15:34:51 +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 Added disclaimer. 1996-10-25 15:40:20 +00:00
lib Fixed index references to modules. 1997-12-15 22:28:38 +00:00
mac Added some module references to the index. 1997-12-15 21:40:15 +00:00
ref Some manipulations with tags to get the TOC and Index to look better 1997-12-06 00:39:45 +00:00
templates At the top, made it clear that the \bimodindex{} and \stmodindex{} are only 1997-12-15 21:20:03 +00:00
texinputs Planned release date for 1.5b2. 1997-12-10 18:56:48 +00:00
tools Added the "italic correction" command ("\/") to the list of ignored commands. 1997-11-25 04:06:21 +00:00
tut Make examples consistently use 4-space indentation. 1997-12-04 15:43:15 +00:00
.cvsignore Add the four latex2html output directories: api, ext, lib, tut. 1997-10-06 13:20:17 +00:00
.latex2html-init add_idx(): Don't add unnecessary markup around the little markers stuck in the 1997-12-11 21:46:07 +00:00
Makefile Use $LOGNAME instead of $USER to get the current user -- it seems to 1997-12-01 18:50:09 +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 Several changes, e.g. restructuring of the intro to be closer to what 1997-11-25 15:34:51 +00:00
boilerplate.tex Planned release date for 1.5b2. 1997-12-10 18:56:48 +00:00
copyright.tex Added disclaimer. 1996-10-25 15:40:20 +00:00
custlib.py A nicety (author lost). 1997-06-02 17:57:10 +00:00
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 Merge alpha100 branch back to main trunk 1994-08-01 12:22:53 +00:00
fix_hack Merge alpha100 branch back to main trunk 1994-08-01 12:22:53 +00:00
fix_libaux.sed (fix_libaux.sed): Hackish little sed script to modify lib.aux to get section 1996-11-11 20:49:27 +00:00
index.html Simple index for the reference manuals (mostly for use on the Windows 1997-11-25 18:27:23 +00:00
keywords.py libsocket.tex: send[to] returns nbytes. 1994-08-01 12:18:36 +00:00
lib.tex Fixed SFT #23842: leave in non-standard style options when checking in an 1997-12-08 15:48:35 +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 buffer_info() docs. 1997-08-14 19:50:37 +00:00
libaudioop.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libbase64.tex Added \indexsubitem definition; functions were previously indexed for the 1997-11-30 05:53:22 +00:00
libbastion.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libbinascii.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libbltin.tex AMK's megapatch: 1997-07-17 16:34:52 +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 added code.py; codehack.py is obsolete 1997-07-18 21:08:07 +00:00
libcommands.tex Don't use $math$ mode to typeset a simple '>' sign. Use \code, not \samp. 1997-11-25 00:43:34 +00:00
libcopy.tex Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libcrypt.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libcrypto.tex Changed URL for PCT again. 1996-10-22 02:25:24 +00:00
libctb.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libdbm.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libdis.tex Arg; more nits, but I may as well finish the job. 1997-12-04 04:57:56 +00:00
liberrno.tex Added doc for errorcode dictionary. 1997-11-18 15:27:51 +00:00
libexcs.tex The sequence behavior is now on the Exception root class rather than 1997-10-07 14:41:04 +00:00
libfcntl.tex Fixed index references to modules. 1997-12-15 22:23:52 +00:00
libfl.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libfm.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libfnmatch.tex regex -> re 1997-12-15 17:53:31 +00:00
libformatter.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libftplib.tex Provide default for blocksize on retrbinary (Skip Montanaro). 1997-12-03 19:34:14 +00:00
libfuncs.tex Fixed index references to modules. 1997-12-15 22:28:38 +00:00
libgdbm.tex Changed {\sc gdbm} to \code{gdbm} everywhere. 1997-12-04 04:45:28 +00:00
libgetopt.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libgl.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libglob.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libgopherlib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libgrp.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libgzip.tex New from AMK 1997-07-17 16:26:11 +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 AMK's megapatch: 1997-07-17 16:34:52 +00:00
libimp.tex Update the description and the example to the new functionality, which 1997-09-09 20:53:37 +00:00
libintro.tex minor things 1995-04-04 12:29:37 +00:00
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 Adding Martin von Loewis' documentation for his locale module. 1997-11-20 21:04:27 +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 Misc Mac mods by Jack. Added libmacic.tex, and these patches: 1997-08-18 15:14:26 +00:00
libmacos.tex Changed description of SchedParams() in the following way: 1997-08-22 13:51:31 +00:00
libmacostools.tex AMK's megapatch: 1997-07-17 16:34:52 +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 Misc Mac mods by Jack. Added libmacic.tex, and these patches: 1997-08-18 15:14:26 +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 AMK's megapatch: 1997-07-17 16:34:52 +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 New stuff by AMK. 1997-04-03 22:41:49 +00:00
libmm.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libmods.tex Lots of small corrections by Andrew Kuchling (plus all new rotor docs) 1994-08-08 12:30:22 +00:00
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 AMK's megapatch: 1997-07-17 16:34:52 +00:00
libobjs.tex minor things 1995-04-04 12:29:37 +00:00
liboperator.tex Removed unnecessary escaping. 1997-12-04 14:20:59 +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 Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libposix.tex Changed illegal \stmodindex{} to \refstmodindex{}, added index reference 1997-12-15 21:42:51 +00:00
libposixfile.tex Added embryonic description of fcntl.lockf(). Added pointer to that 1996-10-11 17:43:34 +00:00
libppath.tex Fixed index references to modules. 1997-12-15 21:56:05 +00:00
libpprint.tex Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
libprofile.tex Clarified reference to old profiler. 1997-11-18 15:28:46 +00:00
libpwd.tex AMK's megapatch: 1997-07-17 16:34:52 +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 libqueue.tex: Documentation for the Queue.py module. 1997-11-20 19:54:16 +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 AMK's megapatch: 1997-07-17 16:34:52 +00:00
libre.tex AMK's latest version. 1997-12-11 20:19:08 +00:00
libregex.tex Added note about the module's obsolescence. 1997-12-09 19:45:47 +00:00
libregsub.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libresource.tex Some reorganization (all limit operations & constants together, and all usage 1997-12-06 07:25:41 +00:00
librestricted.tex Done with this for 1.4. 1996-10-24 22:14:06 +00:00
librexec.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
librfc822.tex AMK's megapatch: 1997-07-17 16:34:52 +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 restructured library manual accordiung to functional group 1995-03-28 13:35:14 +00:00
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 AMK's megapatch: 1997-07-17 16:34:52 +00:00
libstd.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libstdwin.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libstring.tex count() now has a 4th parameter too. Also rephrased the docs for find 1997-10-20 22:40:26 +00:00
libstrings.tex Added ref to StringIO docs. 1997-03-03 16:03:05 +00:00
libstrio.tex Note that getvalue() must be called before close(). 1997-07-17 16:29:04 +00:00
libstruct.tex Ignore whitespace between formats (not internal to a count+format). 1997-08-26 20:39:54 +00:00
libsun.tex typos, layout and other small things 1995-04-10 11:34:00 +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 At the top, made it clear that the \bimodindex{} and \stmodindex{} are only 1997-12-15 21:20:03 +00:00
libtermios.tex Fixed index references to modules. 1997-12-15 22:28:38 +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 Fixed index references to modules. 1997-12-15 22:19:46 +00:00
libtypes2.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libundoc.tex Removed Queue.py. It's documented now. 1997-12-01 16:35:54 +00:00
libunix.tex Spell Unix, not UNIX. 1997-04-02 06:06:03 +00:00
liburllib.tex Fixed index references to modules. 1997-12-15 22:13:50 +00:00
liburlparse.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libuser.tex Reference to PYTHONPATH should be PYTHONSTARTUP. 1997-12-09 19:46:45 +00:00
libuserdict.tex Added docs for UserDict,UserList 1997-03-27 14:56:18 +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 Add xmllib; remove (slow) from description of htmllib. 1997-11-18 15:30:40 +00:00
libxdrlib.tex Ooops, found too more references to old conditions on floating point values. 1997-10-24 21:15:55 +00:00
libxmllib.tex Changed \indexsubitem from ({\tt XMLParser} method) to just (XMLParser method). 1997-12-12 05:32:31 +00:00
libzlib.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
myformat.perl Added Emacs turd so this file has the correct mode in Emacs / X/Emacs, even 1997-12-08 20:59:54 +00:00
myformat.sty \refmodindex{}: New macro, used to make an index reference to a module which 1997-12-15 22:08:14 +00:00
partparse.py Added the "italic correction" command ("\/") to the list of ignored commands. 1997-11-25 04:06:21 +00:00
texi2html.py (texi2html.py): Minor improvement to HTML 3.0 output for code examples. 1996-10-25 22:13:59 +00:00
texipost.dat Incorporated Jan-Hein's changes and texinfo conversion. 1992-12-08 14:37:55 +00:00
texipre.dat Added disclaimer. 1996-10-25 15:40:20 +00:00
text2latex.py * text2latex.py: call main() instead of always processing ext.tex. 1993-11-19 13:13:22 +00:00
tut.tex Make examples consistently use 4-space indentation. 1997-12-04 15:43:15 +00:00
whichlibs At release 1.0.1. Scripts, Makefile, README: cosmetic changes and 1994-02-15 15:59:23 +00:00

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.