Fred Drake
9ac80cb5bd
Removed references to ni.
1998-04-02 18:45:09 +00:00
Fred Drake
b401637bd8
Markup nits, index entries.
1998-04-02 18:44:38 +00:00
Fred Drake
674e0fd7a8
Be more specific about where in RFC 1421 to look, since it's not at all
...
obvious when taking a quick look.
Say "base64" instead of "base-64", since that seems to be how it's referred
to in other RFCs.
1998-04-02 16:24:29 +00:00
Fred Drake
b789c70d05
Minor markup nits.
1998-04-02 16:19:15 +00:00
Fred Drake
f14e2f8a04
Fix one remaining internal use of \code{} that could use the simpler form.
1998-04-02 16:09:02 +00:00
Fred Drake
9e9c89e67c
Some nits.
...
Fixed quoting in third paragraph of the findmatch() description.
1998-04-02 15:53:07 +00:00
Fred Drake
ac8f91ada4
Added --split for AMK; control split level of the HTML output. Use --split 1
...
to create a single HTML file.
Added --help.
1998-04-02 15:37:13 +00:00
Fred Drake
a0dbddfcc0
Markup consistency nits.
...
Fix indentation in code sample in PyArg_ParseTuple() section.
Added one index entry.
Fix include file reference in "Shared Libraries" to print <...> instead of
the upside-down versions of ! and ?.
1998-04-02 06:50:02 +00:00
Fred Drake
c6fa34e4d0
Markup consistency & nits.
...
Fix typo in a C code example: KeyError is spelled PyExc_KeyError in C; the
"K" is upper case!
Some index entries.
On function signatures, always use parameter names. Make return types match
what's in the header files. When the return type is a pointer, always omit
the space between te type name and the "*"; leaving it in results in
type * func(..)
and having two spaces there just looks terrible.
1998-04-02 06:47:24 +00:00
Guido van Rossum
e9625e86b8
AMK's version from the latest pypcre distribution. This clarifies a
...
few things and adds docs for what happens to escapes in replacement
strings.
1998-04-02 01:32:24 +00:00
Fred Drake
391564f10f
Small markup nits, a few grammatical fixes, and a clarification of the binary
...
mode for files under MacOS.
Updated the traffic figure for c.l.p in the "What Now?" chapter; see comments.
1998-04-01 23:11:56 +00:00
Fred Drake
1a7af3959b
Implemented one more special markup item.
1998-04-01 22:44:56 +00:00
Fred Drake
454a4fb018
Added some comments.
1998-04-01 22:20:14 +00:00
Fred Drake
982d91fb51
Change $ICONSERVER to conform to the value AMK & I have discussed for this;
...
doing this here may prove to not be such a good idea, but we'll see.
1998-03-27 06:53:13 +00:00
Fred Drake
8fe533e6a0
Use the new {methoddesc} and {memberdesc} environments as appropriate.
1998-03-27 05:27:08 +00:00
Fred Drake
ec56109a0a
First (rough) cut at HTML index generation in Python. Not very pretty, but
...
easier to work with than the Perl code.
1998-03-27 05:25:43 +00:00
Fred Drake
19e2ce58bf
Add support for mapping internal labels used from the index.
1998-03-27 05:24:53 +00:00
Fred Drake
48a16bf6b5
\tableofcontents: Add support for some warning reduction in python.sty.
1998-03-27 05:24:03 +00:00
Fred Drake
6cb71491de
Add comments about several of the environments.
...
Cleaned up some problems that caused minor warnings.
Added environments for object methods and members, with non-indexing variants.
This includes reduced use of the indexsubitem setting, allowing more robust
index generation.
Removed some unused definitions.
1998-03-27 05:22:53 +00:00
Fred Drake
235e6b1428
Some cleanup.
...
Remove index generation from Perl; use an external script instead.
1998-03-27 05:19:43 +00:00
Fred Drake
8821ecb9cc
Added note about weird sequencing of <PRE> & <dl> around {verbatim} sections.
1998-03-27 05:18:45 +00:00
Fred Drake
6355bd43e5
Clarified some comments about the requirements on the TeX installation.
...
Added brief section on the howto support.
1998-03-27 05:17:21 +00:00
Fred Drake
42b31a5536
Lots and lots and lots.....
...
Implemented some new features of python.sty for methods & members.
Fixed some bugs.
Cleaned up some perl code and made some basic regular expressions more robust.
1998-03-27 05:16:10 +00:00
Fred Drake
f76abb51ef
Make sure both hyphens of a long-option show up in the HTML output.
1998-03-27 00:37:40 +00:00
Fred Drake
55730316c9
Don't use the fncychap package for HOWTO documents; appendices break. Still
...
use them for manuals.
1998-03-25 15:41:23 +00:00
Fred Drake
050be83da9
Python HOWTO template document, with lots of help from AMK.
1998-03-25 15:39:49 +00:00
Fred Drake
f6b55106a7
Update.
1998-03-25 14:56:01 +00:00
Fred Drake
c0b2e453ae
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the
...
latest pdftex. (Which we have here at CNRI.) This makes the PDF targets
work again.
1998-03-25 14:53:43 +00:00
Fred Drake
f558e3188e
Make $MYDIR absolute -- bug reported by AMK.
1998-03-24 17:48:20 +00:00
Fred Drake
2543769ca5
Use "/usr/bin/env perl" for the #! line, and change the -i option to:
...
use English;
$INPLACE_EDIT = '';
to get the inplace-editing behavior.
1998-03-19 05:17:49 +00:00
Fred Drake
1125488b24
build_dvi(): Make sure we run latex enough times; this now matches the #
...
of times pdflatex would be run, which is correct.
1998-03-18 22:06:13 +00:00
Guido van Rossum
685ef4e604
According to Tim Peters, there should be 'print' statements in one
...
particular example.
1998-03-17 14:37:48 +00:00
Fred Drake
cce1090d49
Change "\," to just "," in function signatures. This is easier to maintain,
...
works better with LaTeX2HTML, and allows some simplification of the python.sty
macros.
1998-03-17 06:33:25 +00:00
Fred Drake
c9a4438c16
Coding cleanups.
...
Fix some small but messy buglets.
1998-03-17 06:29:13 +00:00
Fred Drake
13210ed55f
Get the index working at least partway again.
...
Some small cleanups.
1998-03-17 06:28:05 +00:00
Fred Drake
bd2796e972
Update....
1998-03-17 06:24:10 +00:00
Fred Drake
f3aa0e0627
Revert the index stuff to work better with LaTeX2HTML.
1998-03-17 06:23:13 +00:00
Fred Drake
396a7cfb94
Reverting some the index stuff to use tools/newind.py again; this works
...
better with LaTeX2HTML.
Run pdflatex twice to generate the PDF files, even though LaTeX has already
been run a couple of times. This ensures that font metrics for the final
run match those for the first run, and seesm to get (somewhat) better
outline results.
1998-03-17 06:22:12 +00:00
Fred Drake
a2be9881f0
Reverting some of the index stuff to work with LaTeX2HTML better.
1998-03-17 06:20:04 +00:00
Fred Drake
af5c0fc65f
Logical markup, consistency.
1998-03-17 02:02:51 +00:00
Fred Drake
e603cb1073
Revive newind.py. -sigh-
1998-03-16 16:15:49 +00:00
Fred Drake
d98329cdf0
Logical markup.
...
Convert a {description} list to a {tableii} environment.
1998-03-16 06:38:42 +00:00
Fred Drake
ae25be2e4d
{classdesc} environment: Index as "Foo (class in foolib)" instead of
...
"Foo (in module foolib)". Is now independent of indexsubitem.
1998-03-16 05:26:10 +00:00
Fred Drake
1a855fad30
Markup nits.
...
Adjusted some index entries.
1998-03-16 05:23:50 +00:00
Fred Drake
abdea226dc
Adjusted an index entry.
1998-03-16 05:22:08 +00:00
Fred Drake
52405c899a
Added an index entry.
1998-03-16 05:21:08 +00:00
Fred Drake
7bf5e0828f
Use {classdesc} consistently.
1998-03-16 05:07:04 +00:00
Fred Drake
c9808b3af2
Logical markup.
...
Emphasized title "4Sight User's Guide".
1998-03-15 02:04:59 +00:00
Fred Drake
5f874d618f
Markup nits.
...
Some additional index entries.
1998-03-15 01:59:57 +00:00
Fred Drake
ebce37087d
Logical markup.
1998-03-14 22:22:14 +00:00
Fred Drake
f90dbc9c87
Logical markup.
1998-03-14 21:53:48 +00:00
Fred Drake
bd9ded8190
Logical markup.
...
Replace ugly {description} with a {tableii}, for the what() return values.
1998-03-14 20:09:15 +00:00
Fred Drake
434493b207
Logical markup.
...
Replace ugly {description} with a {tableii}, for the option descriptions.
1998-03-14 19:47:23 +00:00
Fred Drake
a891230688
Logical markup, using {classdesc} as appropriate.
1998-03-14 07:08:02 +00:00
Fred Drake
f9e1f658ed
Logical markup.
1998-03-14 07:00:41 +00:00
Fred Drake
2e495c93b0
Logical markup, using {classdesc} as appropriate.
1998-03-14 06:48:33 +00:00
Fred Drake
be2b6d7f42
Logical markup.
1998-03-14 06:40:34 +00:00
Fred Drake
ff79a21119
Logical markup.
...
Use {classdesc} environments to describe the constructors, and place them
at the top.
1998-03-14 06:30:13 +00:00
Fred Drake
cdea8a3c60
Logical markup.
...
Wrap general Message class description in a {classdesc} instead of nothing at
all.
1998-03-14 06:17:43 +00:00
Fred Drake
0f51fff57e
Logical markup.
1998-03-14 06:16:57 +00:00
Fred Drake
fc16e78f3c
Bring this up to date. Some things still don't work right.
1998-03-12 21:03:26 +00:00
Fred Drake
94fac130bb
\regexp{}: Rewritten to look like Freidl's book. Too rip-off?
...
\envvar{}: Bow to font-lock-mode a few times...!
1998-03-12 19:37:03 +00:00
Fred Drake
3b5da76182
Logical markup.
1998-03-12 15:33:05 +00:00
Fred Drake
2dde74c778
Logical markup.
1998-03-12 14:42:23 +00:00
Fred Drake
51375ae07b
Use {classdesc} instead of {funcdesc} for HTMLParser.
...
Clean up index reference to SGMLParser class.
1998-03-12 14:39:09 +00:00
Fred Drake
6ef871ce2f
Logical markup.
...
Lots of nits in both.
1998-03-12 06:52:05 +00:00
Fred Drake
7be8fcb42a
Use \envvar{FOO} instead of \code{\$FOO}.
1998-03-12 06:47:48 +00:00
Fred Drake
4e7e11abe5
Use \withsubitem{} for indexing extra-module functions.
1998-03-12 06:46:16 +00:00
Fred Drake
371ecc0c1b
Use \withsubitem{} for indexing functions from other modules. This fixes
...
things in the index.
1998-03-12 06:44:58 +00:00
Fred Drake
0ee9f727c9
\withsubitem{}: New macro. Change indexsubitem temporarily for another
...
macro. Intended usage:
\withsubitem{(in module foo)}{\ttindex{myfunc()}}
This allows indexing functions from other modules/class/whatnot
without being dependent on the exact expansions of several macros
internal to python.sty. It's also easier to read in the source!
Some new "logical" macros that seem to be useful:
\regexp{}: For regular expressions. To make it easier to keep the appearance
consistent.
\mimetype{}: Don't use \code{}!
\envvar{}: Environment variable. This does some indexing as well.
\character{}: Just a character we want to talk about in the text, but not
a Python constant.
1998-03-12 06:41:40 +00:00
Fred Drake
6a1eefe535
Logical markup.
1998-03-12 06:04:53 +00:00
Fred Drake
a2e9818467
Logical markup.
...
Improve some index entries.
1998-03-12 05:54:02 +00:00
Fred Drake
c71585e069
Logical markup.
...
Markup consistency.
Removed incorrect \setindexsubitem{}.
1998-03-12 05:33:40 +00:00
Fred Drake
4912beb9d8
Add copyright statement.
...
Add section on using A4 paper, since that's a common request.
1998-03-11 17:07:35 +00:00
Fred Drake
664b36ff59
*Sigh*
...
Add a -q option for "quiet" operation. Nothing gets out (not even stderr,
since that's tossed to stdout for capture in the .how file). It's a good
idea to use -l to get the log in case there are problems. Maybe this should
be the default and add a --verbose option to get the stdout? There's way
too much junk output.
1998-03-11 15:41:21 +00:00
Fred Drake
dbc879e949
Allow the user to operate the script in debugging mode (-D), which just does
...
a "set -x".
Allow keeping a transcript, using -l, in $FILE.how.
Allow keeping of all the temp files created by the process, using -k.
1998-03-11 15:33:44 +00:00
Fred Drake
c9f2c14d49
Somewhat more direct way of locating the file, using __FILE__.
...
Leave find_my_file() around for now, even though we're not using it at the
moment.
1998-03-11 12:08:21 +00:00
Fred Drake
bc8ad5bdeb
Replace lists of attributes for code and frame objects with a reference to the
...
Python Reference Manual.
1998-03-11 06:29:59 +00:00
Fred Drake
fdbd51db8b
Logical markup.
1998-03-11 06:24:46 +00:00
Fred Drake
60ba44750f
Logical markup.
1998-03-11 06:18:15 +00:00
Fred Drake
295eaa84b0
Logical markup.
...
Changed example to use "import posixfile" instead of "from posixfile import *"
since only one symbol was used.
1998-03-11 06:11:37 +00:00
Fred Drake
e42f595e5c
Logical markup.
...
Made references to constants in other TERMIOS module explicit in termios
description.
Removed superfluous backslash from example.
1998-03-11 06:00:23 +00:00
Fred Drake
db9693ec97
Logical markup.
1998-03-11 05:50:42 +00:00
Fred Drake
75aae9ad89
Logical markup.
...
Added information on the exception attributes when exceptions are classes.
1998-03-11 05:29:58 +00:00
Fred Drake
e2e904f303
Script to format HOWTO documents. Currently only tested on the "Using
...
Kerberos from Python" HOWTO (this will change shortly, I hope).
This needs to be run from it's location in the Doc/tools directory, and
not via a symlink. I'll try and fix this in the future.
The help message needs work.
1998-03-10 23:23:05 +00:00
Fred Drake
db34a1e2d8
Use the location of the initialization file to augment the style-specific
...
.perl file search path, rather than making assumptions about the current
directory.
1998-03-10 23:02:57 +00:00
Fred Drake
eff1f7622a
clean_title(): Remove debugging prints.
1998-03-10 14:33:27 +00:00
Fred Drake
ac77b79df6
clean_title(): Clean a little more carefully. Still does funny things with
...
underscores. Might this be a fundamental PDF limitation? Hm, could
still be a TeX thing.
1998-03-10 14:02:35 +00:00
Fred Drake
45e564dd78
In the source dist., don't include:
...
- the .cvsignore files; these are only useful in the CVS tree
- ref/ref.pdf
- ref/ref.ps
After compression, these last two account for about one-half MB, and half
the tarball. They can be picked up from the appropriate format dist if
needed.
1998-03-10 14:00:55 +00:00
Fred Drake
b30d0164bf
Logical markup.
1998-03-10 05:41:08 +00:00
Fred Drake
4ef3329259
Logical markup.
...
Correct misuse of indexsubutem.
Describe the Queue class using {classdesc}{Queue}, not {funcdesc}{__init__}.
1998-03-10 05:32:30 +00:00
Fred Drake
8aee0e0356
Add some more labels for logical addressing.
1998-03-10 05:21:39 +00:00
Fred Drake
d883ca1dcb
Logical markup.
1998-03-10 05:20:33 +00:00
Fred Drake
193338afeb
Logical markup.
...
Convert one bulleted list to a {tableii} environment; the other should
probably be converted, but I haven't decided to what.
1998-03-10 04:23:12 +00:00
Fred Drake
2cb1074937
Use a {datadesc} environment to describe errorcode.
1998-03-10 03:53:03 +00:00
Fred Drake
92f31f1260
Logical markup.
1998-03-10 03:38:31 +00:00
Fred Drake
a44d74086c
Logical markup.
...
Use {funcdesc} and {excdesc} to describe the module, not just running text.
1998-03-10 03:36:00 +00:00
Fred Drake
c4f15af7de
Logical markup. small nits.
1998-03-10 03:17:26 +00:00
Fred Drake
520f8bd9b7
Ok, remove dependency on the obsolete tools/modindex.py.
1998-03-09 16:43:54 +00:00
Fred Drake
97c73c83ed
Remove \newif relating to index support; no longer needed. Index control
...
is now shared and located solely in python.sty.
1998-03-09 16:40:31 +00:00