packaging_cpython / Doc /

The branch 'legacy-trunk' does not exist.
Filename Size Date modified Message
..
ext
info
lib
mac
ref
templates
texinputs
tools
tut
26 B
2.7 KB
3.3 KB
198 B
1.1 KB
40.7 KB
220 B
86 B
395 B
2.0 KB
6.2 KB
6.0 KB
3.5 KB
3.8 KB
3.4 KB
9.8 KB
235 B
523 B
1.0 KB
7.2 KB
2.3 KB
14.0 KB
2.7 KB
17.8 KB
1.4 KB
1.8 KB
5.1 KB
1.0 KB
3.5 KB
2.7 KB
7.0 KB
672 B
1.9 KB
1.0 KB
241 B
2.5 KB
1.8 KB
1.9 KB
211 B
342 B
3.0 KB
776 B
3.1 KB
2.1 KB
11.3 KB
5.3 KB
4.7 KB
965 B
679 B
7.7 KB
1.3 KB
1.8 KB
4.4 KB
1.9 KB
161 B
12.0 KB
345 B
25.7 KB
5.5 KB
2.8 KB
4.6 KB
5.9 KB
1.1 KB
3.6 KB
3.8 KB
24.5 KB
185 B
594 B
3.7 KB
6.1 KB
58.8 KB
58.5 KB
3.2 KB
1.7 KB
3.8 KB
12.2 KB
30.8 KB
6.7 KB
24.6 KB
18.3 KB
15.7 KB
3.2 KB
306 B
3.5 KB
1.3 KB
108.1 KB
71 B
Python main documentation -- in LaTeX
-------------------------------------

This directory contains the LaTeX sources to the Python documentation
and a published article about Python.

The following are the LaTeX source files:

	tut.tex				The tutorial
	lib.tex, lib*.tex		The library reference
	ref.tex, ref[1-8].tex		The reference manual
	ext.tex				How to extend Python
	qua.tex, quabib.bib		Article published in CWI Quarterly

All except qua.tex (which isn't built by the default target) use the
style option file "myformat.sty".  This contains some macro
definitions and sets some style parameters.

The style parameters are set up for European paper size (21 x 29.7 cm,
a.k.a. A4, or roughly 8.27 x 11.7 inch) by default.  To use US paper,
comment out the line saying \input{a4wide.sty} in myformat.sty (you
may want to fiddle with lay-out parameters like \textwidth and
\textheight, since the default format uses rather wide margins).

You need the makeindex utility to produce the index for ref.tex
lib.tex; you need bibtex to produce the references list for qua.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.  Printing depends on
local conventions; at my site, I use dvips and lpr.  For example:

	make ref			# creates ref.dvi
	xdvi ref			# preview it
	dvips -Ppsc ref | lpr -Ppsc	# print it on printer "psc".

If you don't have latex, you can ftp the pre-formatted PosytScript
versions of the documents.  It should be in the same place where you
fetched the main Python distribution, if you got it by ftp.  (See
"../Misc/FAQ" for information about ftp-ing Python files.)


Making the INFO version of the Library Reference
------------------------------------------------

The Library Reference can now also be read in hypertext form using the
Emacs INFO system.  This uses Texinfo format as an intermediate step.
It requires texinfo version 2 (we have used 2.14).

To build the info files (python-lib.info*), say "make lib.info".  This
takes a while, even on machines with 33 MIPS and 16 Mbytes :-) You can
ignore the output.

But first you'll have to change a site dependency in fix.el: if
texinfo 2.xx isn't installed by default at your site, you'll have to
install it (use archie to locate a version and ftp to fetch it).  If
you can't install it in the standard Emacs load path, uncomment the
line containing a "(setq load-path ...)" statement, and fill in the
path where you put it.

The files used by the conversion process are:

partparse.py            Python script that converts LaTeX sources to
			texi files.

texi{pre,post}.dat      Files placed before and after the result.

fix.el                  Elisp file executed by Emacs. Two calls to
                        'texinfo-all-menus-update are necessary in
			some cases.

fix_hack		Shell script to fix the results of the
                        "underscore hack". {\ptt \char'137} is
                        back-translated to a simple underscore.  This
                        is needed for the texindex program.

whichlibs		Shell script to print a list of lib*.tex files
			to be processed.

A Million thanks for Jan-Hein B\"uhrman for writing and debugging the
convertor and related scripts, and for fixing the LaTeX sources and
writing new macros for myformat.sty!
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.