Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
cpython/Doc
History
Fred Drake 00dcfb2bc3 &get_indexsubitem: This now has a chance of working, thanks to: 
&do_cmd_setindexsubitem:  New function.  Set the indexsubitem value from
	\setindexsubitem{(...)}.

&do_env_opcodedesc:  By default, don't index byte codes.

$INDEX_OPCODES:  New flag.  If true, index the byte codes.  Default is off.

Normalize indentation to 4 spaces everywhere.

Minor nits.
 		1998-02-13 07:21:03 +00:00
..
api Remove obsolete pagenumbering / pagestyle cruft. 1998-02-13 07:08:56 +00:00
ext Remove \bcode / \ecode everywhere. 1998-02-13 07:11:32 +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 Remove obsolete pagenumbering / pagestyle cruft. 1998-02-13 07:08:56 +00:00
mac Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
ref Removed a confusing note about coercions and __r*__ operators. 1998-01-19 23:16:55 +00:00
templates Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
texinputs Use new \authoraddress{}; author's name and address are now separate. 1998-02-12 03:16:04 +00:00
tools parse_line(): Strip whitespace from the module name. 1998-02-13 05:11:05 +00:00
tut Remove \bcode / \ecode everywhere. 1998-02-13 07:16:30 +00:00
.cvsignore Tell CVS to ignore PDF files. 1998-02-04 20:27:39 +00:00
.latex2html-init Override several functions from the stock latex2html to support the module 1998-01-13 04:03:02 +00:00
Makefile Clean up some of the definitions related to info generation. 1998-02-13 03:23:33 +00:00
README Add note about dropping latex 2.09 compatibility. 1998-01-19 23:10:21 +00:00
api.tex Remove obsolete pagenumbering / pagestyle cruft. 1998-02-13 07:08:56 +00:00
boilerplate.tex Use new \authoraddress{}; author's name and address are now separate. 1998-02-12 03:16:04 +00:00
copyright.tex Mark the URL "ftp://ftp.python.org" with \url{}. 1998-02-11 14:42:06 +00:00
custlib.py A nicety (author lost). 1997-06-02 17:57:10 +00:00
ext.tex Remove \bcode / \ecode everywhere. 1998-02-13 07:11:32 +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 (fix_libaux.sed): Hackish little sed script to modify lib.aux to get section 1996-11-11 20:49:27 +00:00
fncychap.sty New file. Written by Ulf A. Lindgren <lindgren@ae.chalmers.se>; we have 1998-02-11 23:01:23 +00:00
index.html Simple index for the reference manuals (mostly for use on the Windows 1997-11-25 18:27:23 +00:00
indfix.py Minor performance nits. 1998-02-10 21:35:49 +00:00
keywords.py
…
lib.tex Remove obsolete pagenumbering / pagestyle cruft. 1998-02-13 07:08:56 +00:00
libaifc.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libal.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
liballos.tex Consistency: 1998-01-13 19:00:33 +00:00
libamoeba.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libanydbm.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libarray.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libaudioop.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libbase64.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libbasehttp.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libbastion.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libbinascii.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +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 Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libcgi.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libcmath.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libcode.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libcommands.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libcopy.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libcopyreg.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libcrypt.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +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 Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libdbm.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libdis.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
liberrno.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libexcs.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libfcntl.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libfl.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libfm.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libfnmatch.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libformatter.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libftplib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libfuncs.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libgdbm.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libgetopt.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libgl.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libglob.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libgopherlib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libgrp.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libgzip.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libhtmllib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libhttplib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libimageop.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libimgfile.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libimghdr.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libimp.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libintro.tex
…
libjpeg.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libkeyword.tex Documentation for the keyword module. 1997-10-06 21:39:16 +00:00
liblocale.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmac.tex Added some module references to the index. 1997-12-15 21:40:15 +00:00
libmacconsole.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmacdnr.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmacfs.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmacic.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmacos.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmacostools.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmacspeech.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmactcp.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmacui.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmailbox.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmailcap.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmain.tex AMK's megapatch: 1997-07-17 16:34:52 +00:00
libmarshal.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmath.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmd5.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmimetools.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmimify.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libmisc.tex Added missing entry for cmath. 1998-02-11 22:33:57 +00:00
libmm.tex (lib<all sorts of stuff>.tex): 1996-12-13 22:04:31 +00:00
libmods.tex
…
libmpz.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libni.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libnntplib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libobjs.tex Removed bogus index entry for the type() built-in. 1998-01-20 05:12:36 +00:00
liboperator.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libos.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libpanel.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libparser.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libpdb.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libpickle.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libposix.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libposixfile.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libppath.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libpprint.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libprofile.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libpwd.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libpython.tex Split UserDict and UserList on two separate lines; added entries for 1998-02-11 22:36:17 +00:00
libqueue.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libquopri.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
librand.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
librandom.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libre.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libregex.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libregsub.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libresource.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
librestricted.tex Done with this for 1.4. 1996-10-24 22:14:06 +00:00
librexec.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
librfc822.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
librgbimg.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
librotor.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libselect.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsgi.tex
…
libsgmllib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libshelve.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsignal.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsite.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsocket.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsocksvr.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsomeos.tex Add description for Queue; fix typo (whichdbm should be whichdb). 1997-11-20 21:00:03 +00:00
libsoundex.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libstat.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libstd.tex
…
libstdwin.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libstring.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libstrings.tex Added entries for re, soundex modules. 1998-02-11 22:57:10 +00:00
libstrio.tex Consistency: "{\bf ...}" ==> "\strong{...}" 1998-01-14 14:51:31 +00:00
libstruct.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsun.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsys.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libsyslog.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libtempfile.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libtemplate.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libtermios.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libthread.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libtime.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libtraceback.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libtypes.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libtypes2.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libundoc.tex Removed entry for copy_reg module. 1998-01-21 05:00:28 +00:00
libunix.tex Added entries for stat, commands modules. 1998-02-11 22:58:55 +00:00
liburllib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
liburlparse.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libuser.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libuserdict.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libwhichdb.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libwhrandom.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libwww.tex Use the new RFC macros wherever RFCs are referenced by number. No other 1998-02-09 19:16:20 +00:00
libxdrlib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libxmllib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
libzlib.tex Remove all \bcode / \ecode cruft; this is no longer needed. See previous 1998-02-13 06:58:54 +00:00
modindex.py parse_line(): Strip whitespace from the module name. 1998-02-13 05:11:05 +00:00
myformat.perl &get_indexsubitem: This now has a chance of working, thanks to: 1998-02-13 07:21:03 +00:00
myformat.sty Lots of stuff: 1998-02-13 06:48:05 +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
…
texipre.dat Updated release date to match boilerplate.tex. 1997-12-30 04:42:49 +00:00
text2latex.py
…
tut.tex Remove \bcode / \ecode everywhere. 1998-02-13 07:16:30 +00:00
whichlibs
…

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.