Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
cpython/Doc
History
Guido van Rossum ad37e9e77d Clarify that capwords() removes leading/trailing whitespace. 
Remove references to regsub, which is obsolescent.
 		1998-02-02 03:01:10 +00:00
..
api Py_AtExit(): Added brief note about the constraint on cleanup functions not 1998-01-26 19:16:27 +00:00
ext Use \url{} to mark URLs. 1998-01-22 20:44:18 +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 Clarify that capwords() removes leading/trailing whitespace. 1998-02-02 03:01:10 +00:00
mac Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +00:00
ref Removed a confusing note about coercions and __r*__ operators. 1998-01-19 23:16:55 +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 Consistency: "{\tt ...}" ==> "\code{...}" 1998-01-20 04:55:47 +00:00
tools Script to convert module index data to module index. 1998-01-02 03:00:27 +00:00
tut Use \url{} to mark URLs. 1998-01-22 20:44:18 +00:00
.cvsignore Ignore generated info files. 1997-12-29 21:37:21 +00:00
.latex2html-init Override several functions from the stock latex2html to support the module 1998-01-13 04:03:02 +00:00
Makefile $(LIBFILES): Added libcopyreg.tex. 1998-01-21 04:59:44 +00:00
README Add note about dropping latex 2.09 compatibility. 1998-01-19 23:10:21 +00:00
api.tex Py_AtExit(): Added brief note about the constraint on cleanup functions not 1998-01-26 19:16:27 +00:00
boilerplate.tex Consistency: "{\tt ...}" ==> "\code{...}" 1998-01-20 04:55:47 +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 Use \url{} to mark URLs. 1998-01-22 20:44:18 +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 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 Add entry for copy_reg module. 1998-01-21 04:58:39 +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 Consistency: 1998-01-13 19:00:33 +00:00
libamoeba.tex Consistency: In two places, change {\it ...} to \emph{...}. 1998-01-19 02:51:02 +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 Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +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 Consistency: 1998-01-13 19:00:33 +00:00
libcmath.tex Add index entry for reference to the math module. 1998-01-09 21:30:03 +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 Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +00:00
libcopyreg.tex Simple documentation of the copy_reg module. 1998-01-21 04:58:10 +00:00
libcrypt.tex Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +00:00
libcrypto.tex Use \url{} to mark URLs, \email{} to mark an email address. 1998-01-22 20:45:31 +00:00
libctb.tex Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +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 Added index entry and \label{} for exceptions module. This isn't in the 1998-01-20 05:26:12 +00:00
libfcntl.tex Consistency: 1998-01-13 19:00:33 +00:00
libfl.tex Added the standard \label{module-*} for the two supporting modules. 1998-01-14 05:47:15 +00:00
libfm.tex Consistency: Replaced one {\tt ...} with \code{...}. 1998-01-19 02:55:11 +00:00
libfnmatch.tex "Unix" --> "\UNIX{}" 1998-01-11 19:06:37 +00:00
libformatter.tex Ouch: "accounces" ==> "announces" 1998-01-15 05:49:00 +00:00
libftplib.tex Added index items for the RFC and the protocol itself. 1998-01-07 13:13:42 +00:00
libfuncs.tex Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +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 Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +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 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 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 Consistency: "unix" ==> "\UNIX{}" 1998-01-13 19:01:57 +00:00
libmailcap.tex Consistency: "unix" ==> "\UNIX{}" 1998-01-13 19:03:36 +00:00
libmain.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmarshal.tex Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +00:00
libmath.tex Added descriptions for log() and log10(). 1998-01-22 17:37:50 +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 Consistency: Replaced 4 {\it ...} with \emph{...}. 1998-01-19 04:02:41 +00:00
libni.tex ni is a standard module, not a built-in module. The only other reference to 1998-01-20 04:40:41 +00:00
libnntplib.tex Fixed up index entries. 1998-01-07 13:23:32 +00:00
libobjs.tex Removed bogus index entry for the type() built-in. 1998-01-20 05:12:36 +00:00
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 Consistency: (Yes, I know this section is not formatted by default, and 1998-01-20 04:32:09 +00:00
libparser.tex Added \label{} to allow module references. 1998-01-09 22:24:14 +00:00
libpdb.tex Modify command descriptions to use \optional{} instead of ad-hoc markup. 1998-01-12 15:38:30 +00:00
libpickle.tex Add module reference for cPickle to index. 1998-01-09 22:36:51 +00:00
libposix.tex Consistency: {\it ...} ==> \emph{...} 1998-01-20 04:43:29 +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 entry for copy_reg module. 1998-01-21 05:04:52 +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 Various updates to the effect that the group argument is always optional. 1998-01-19 23:14:17 +00:00
libregex.tex Use \url{} to mark a URL. 1998-01-22 20:47:26 +00:00
libregsub.tex Use \url{} to mark a URL. 1998-01-22 20:47:26 +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 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 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 Consistency: "unix" ==> "\UNIX{}" 1998-01-13 19:03:36 +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 Converted to use semantic markup. This is an example of how many of the new 1998-01-22 15:56:41 +00:00
libsite.tex Removed obsolete \kwindex{} calls. 1998-01-13 18:34:40 +00:00
libsocket.tex Consistency: "{\it ...}" ==> "\emph{...}" 1998-01-20 04:54:23 +00:00
libsocksvr.tex Consistency: "Unix" ==> "\UNIX{}" 1998-01-13 19:10:02 +00:00
libsomeos.tex Add description for Queue; fix typo (whichdbm should be whichdb). 1997-11-20 21:00:03 +00:00
libsoundex.tex The soundex module is built-in, not standard. 1998-01-20 04:45:44 +00:00
libstat.tex Add S_ISBLK(). 1998-01-29 22:03:41 +00:00
libstd.tex Restructured library documentation 1994-01-02 01:22:07 +00:00
libstdwin.tex Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +00:00
libstring.tex Clarify that capwords() removes leading/trailing whitespace. 1998-02-02 03:01:10 +00:00
libstrings.tex Added ref to StringIO docs. 1997-03-03 16:03:05 +00:00
libstrio.tex Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +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 Added "module search path" to the index. 1998-01-13 18:35:51 +00:00
libsyslog.tex Consistency: "Unix" ==> "\UNIX{}" 1998-01-13 22:41:33 +00:00
libtempfile.tex Use \file{} instead of \code{} or ``\code{}'' to mark file & directory names 1998-01-09 22:30:32 +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 Added a bunch of "concept" index entries. 1998-01-20 05:52:23 +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 Add a note explaining that multiplying a sequence with a negative 1998-01-27 19:09:43 +00:00
libtypes2.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libundoc.tex Removed entry for copy_reg module. 1998-01-21 05:00:28 +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 Update comment about relative URL internet draft to reflect current RFC status; 1998-01-21 04:55:02 +00:00
libuser.tex Removed obsolete \kwindex{} call. 1998-01-13 18:45:34 +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 Consistency: "Unix" ==> "\UNIX{}" 1998-01-13 19:10:02 +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 New version of xmllib from Sjoerd. 1998-01-29 14:55:24 +00:00
libzlib.tex Converted to use new macros. This example demonstrate \method{} and, more 1998-01-22 16:11:18 +00:00
modindex.py Script to convert module index data to module index. 1998-01-02 03:00:27 +00:00
myformat.perl Fixed indexing of {datadesc} environments. 1998-01-22 18:14:39 +00:00
myformat.sty \seemodule{}: Use logical markup for the module name, to ensure it picks up 1998-01-22 17:43:15 +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 (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 Updated release date to match boilerplate.tex. 1997-12-30 04:42:49 +00:00
text2latex.py * text2latex.py: call main() instead of always processing ext.tex. 1993-11-19 13:13:22 +00:00
tut.tex Use \url{} to mark URLs. 1998-01-22 20:44:18 +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.
They now require latex2e (latex 2.09 compatibility is dropped).

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.