Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
8,685 Commits 6 Branches 592 Tags 2.5 GiB
Commit Graph

1634 Commits

Author SHA1 Message Date
Fred Drake eb4ed15be8 Shift index entries around a little so the HTML doesn't have weird spacing. 1998-04-11 04:52:15 +00:00
Fred Drake 1e0f8bfea9 Add imaplib to appropriate lists. 1998-04-11 04:27:07 +00:00
Fred Drake 36751b0ed2 Remove obsolete module soundex from list of modules. 1998-04-11 04:23:07 +00:00
Fred Drake c48b772a77 Remove obsolete module rand from list of modules. 
Add fileinput to list.
 1998-04-11 04:22:02 +00:00
Fred Drake 89de314cfc First cut at documentation for imaplib. Based on original documentation by 
Piers Lauders.
 1998-04-11 04:19:04 +00:00
Fred Drake 756a9e87b1 do_env_memberdesc(): Fix argument parsing for {memberdesc} environments. 
(The bug was detected by the Q/A team -- me!  Please, help review the docs!)
 1998-04-11 03:12:06 +00:00
Fred Drake 007bac3b0b Added smtplib.py (thanks, Guido!). 1998-04-09 18:54:01 +00:00
Fred Drake 2cb824cbf9 Don't use \samp when \code is better. 
Consistently use ' instead of ":  this conforms to my unofficial stance that
constants should be presented using the repr() whenever it makes sense.  This
isn't because I think repr() is the greatest thing since spam, just that it's
an easy to adopt consistency standard.  (It also holds no new surprises!)
 1998-04-09 18:10:35 +00:00
Fred Drake 5cca42e0b7 do_cmd_lineii(), 
do_cmd_lineiii():  Fix markup style conversion to HTML tags for first column.
	(The endtag wasn't formed properly.)
 1998-04-09 17:59:11 +00:00
Fred Drake 6b529ae0c0 Remove @webchecker.pickle in the "clean" target. 1998-04-09 15:46:36 +00:00
Fred Drake 45c634ecae Work around a small (& annoying) limitation of the latex2html support for 
\seemodule.  This is far easier than figuring out the real problem, but it
works.
 1998-04-09 15:44:58 +00:00
Fred Drake 8a254b5967 Removed misleading comment about GNU software. This module and the zlib 
library have no relationship with GNU software other than implementing some of
the same algorithms and file format.  (The zlib module is more general.)
 1998-04-09 15:41:44 +00:00
Fred Drake 45084ed52a Added note about current status of info generation. 1998-04-09 15:19:41 +00:00
Andrew M. Kuchling 253328104f Many markup changes (to \regexp, mostly) 
Clarified text on 8-bit cleanness, complemented sets like [^5], and {m,n}
  qualifier.
 1998-04-09 14:56:04 +00:00
Fred Drake 02a8e6b600 Update release number and date. 1998-04-09 14:50:47 +00:00
Fred Drake 20ca9171c1 Don't assume that \version expands to the 3-character major.minor number; it 
is the full release version name ("1.5.1beta1", for instance).

Add section for previously documented obsolete modules.  Includes ni, rand,
and soundex.
 1998-04-09 14:32:28 +00:00
Fred Drake 363ab1a613 Comment out the soundex section. 1998-04-09 14:23:48 +00:00
Fred Drake 2de75ec245 Don't assume that \version expands to the 3-character major.minor number; it 
is the full release version name ("1.5.1beta1", for instance).
 1998-04-09 14:12:11 +00:00
Fred Drake 9da38814a3 Use the correct URL to AMK's regex-to-re HOWTO! 1998-04-09 14:06:33 +00:00
Fred Drake 54c3947fbc Updated URL to AMK's regex-to-re HOWTO. 1998-04-09 14:03:00 +00:00
Fred Drake 5406e7071f Added reference to AMK's HOWTO on the topic. 1998-04-09 14:02:02 +00:00
Fred Drake 223395c0a0 Added imaplib. 1998-04-09 13:55:06 +00:00
Fred Drake b8efda01e6 Update URL to the related HOWTO document. 1998-04-09 13:49:18 +00:00
Fred Drake bd400881dd Add section for ni back in, but comment it out. 1998-04-09 11:04:19 +00:00
Fred Drake eac469ca3d Commented out sections on obsolete & Macintosh modules. 1998-04-09 04:51:07 +00:00
Fred Drake f1b72ddf82 Reduced description of the obsolete method Stats.ignore(). 1998-04-09 04:49:56 +00:00
Fred Drake 058068d992 Nearly a complete re-write. 
Basically, it now works and produces a nice-looking HTML index.

Shows some promise for extensibility, but still young.  Needs useful comments.
 1998-04-08 23:12:51 +00:00
Fred Drake 166abbabf9 Remove option to strip out <tt>...</tt> from index entry text; this is now 
left to the buildindex.py script.

Change the field separator used in the index.dat file so utilities like grep
are useful on these files; they can't typically handle NUL bytes.

Protect index entries for environment variables from being handled as
case-insensitive by buildindex.py.
 1998-04-08 23:10:54 +00:00
Guido van Rossum ae2be7144d Correct definition of CTIME. 1998-04-08 22:44:25 +00:00
Fred Drake 3f3c25fc03 Set flag to remove <tt>...</tt> markup from the index entries; it just ends up 
looking really bad in popular browsers, mostly due to vertical size differences
between the roman and monospaced fonts.
 1998-04-08 13:46:24 +00:00
Fred Drake 2764dd33cf Separate sections on anydbm and dumbdbm. 
This is the last separation; each module now gets its own section.  This will
be useful in performing conversions.
 1998-04-07 22:08:02 +00:00
Fred Drake 8e729ec31a Caught a few more spurious \setindexsubitem macros.... 1998-04-07 22:06:41 +00:00
Fred Drake 5ab5503b8a Use {classdesc} and {memberdesc} where appropriate. 1998-04-07 22:01:33 +00:00
Fred Drake a3f5c32f18 Removed unnecessary \setindexsubitem. 1998-04-07 21:45:52 +00:00
Fred Drake 1ce3604cfd Separate UserDict and UserList documentation into separate sections. 1998-04-07 20:05:33 +00:00
Fred Drake df0e3fcb63 Markup nit. 1998-04-07 20:04:27 +00:00
Fred Drake c708605f4f Added a reference to the discussion in Knuth's "Sorting and Searching", and 
noted that the original algorithm produces 4-character results rather than
the 6-character results provided by this module.
 1998-04-07 19:58:19 +00:00
Fred Drake 41565f66b6 Data attributes of objects should not be indexed with trailing parentheses! 1998-04-07 19:32:40 +00:00
Fred Drake 396b827a93 Minor markup nit. 1998-04-07 19:17:27 +00:00
Fred Drake 82d493fb96 Fixed some index entries. 1998-04-07 19:14:17 +00:00
Fred Drake 6b9ff7257b Added entry for wdb. 1998-04-07 19:09:32 +00:00
Fred Drake 810349b685 Fix the formatting of the list of fields in the disassemble() function. 1998-04-07 14:16:41 +00:00
Fred Drake 272fb3aaa4 Added poplib. 
Made the module lists look like the other module lists in the documentation.
 1998-04-07 14:15:28 +00:00
Fred Drake af370ea254 Move a short paragraph outside the description of ASTType. 1998-04-05 20:23:02 +00:00
Fred Drake 3a0351cf85 Remove all uses of \sectcode; we can now use logical markup everywhere. 1998-04-04 07:23:21 +00:00
Fred Drake e7957184d2 Change \sectcode to logical markup. 1998-04-04 07:17:47 +00:00
Fred Drake fc57619811 Remove obsolete \setindexsubitem macros. 
Massive migration to methoddesc and memberdesc.

Logical markup as needed.

A sprinkling of index entries for flavor.
 1998-04-04 07:15:02 +00:00
Fred Drake 71c1e502f0 Moved some things around. 
Adjusted a couple of the comments to be more informative.

Tell a little bit about what obsolete means now, and how to use obsolete
modules.
 1998-04-04 07:03:19 +00:00
Fred Drake 13beac1289 Removed obsolete \setindexsubitem macros. 1998-04-04 06:46:51 +00:00
Fred Drake 85ea68b2a2 Added index entries. 1998-04-04 06:46:05 +00:00
Fred Drake 81acc2e988 Remove obsolete \setindexsubitem macro. 
Logical markup, methoddesc, etc.
 1998-04-04 06:35:41 +00:00
Fred Drake 61f45c7cb5 Remove obsolete \setindexsubitem macro, 
Added index entries.

Markup nits.
 1998-04-04 06:31:51 +00:00
Fred Drake b208f128b4 Added index entry. 1998-04-04 06:28:54 +00:00
Fred Drake 82143348aa Remove obsolete \setindexsubitem macro. 1998-04-04 06:28:14 +00:00
Fred Drake 858f787a02 Fix index entry for HTMLParser class. 1998-04-04 06:25:27 +00:00
Fred Drake 41788db3e2 Logical markup. 
Index entries.
 1998-04-04 06:23:02 +00:00
Fred Drake 9b28fe285d Logical markup. 1998-04-04 06:20:28 +00:00
Fred Drake e14dde2117 Fixed description of similarity between m[name] and m.getheader(name), 
reported by Samuel L. Bayer.

Use methoddesc instead of funcdesc, etc.
 1998-04-04 06:19:30 +00:00
Fred Drake d275de985a Remove obsolete lines like this: 
\setindexsubitem{(in module frobnitz)}

These are no longer needed when present before any other \setindexsubitem{}
in the module section.  The indexsubitem is now set by \bimodindex and
\stmodindex.
 1998-04-04 05:56:51 +00:00
Fred Drake 4bde97f190 Add fileinput section under Misc. Services. 1998-04-04 05:50:12 +00:00
Fred Drake ea2f2b9409 Use new index style for makeindex. 
Add dependency on libfileinput.tex for lib.dvi.
 1998-04-04 04:21:45 +00:00
Fred Drake 35ca0d69e1 Document fileinput. 1998-04-04 04:20:51 +00:00
Fred Drake a8e262b0b2 Use the new index style when running makeindex. 1998-04-04 04:20:21 +00:00
Fred Drake 10ad52e8af Minor cleanliness. 1998-04-04 04:19:20 +00:00
Fred Drake 0a2eb138e7 Style specification for building *.ind from *.idx. This is needed to avoid 
wrapping of long lines, which tools/indfix.py doesn't understand, and needs
to to handle collapsing of entries which can share a common emtry and just
be short entries themselves.  We get the added benefit of nicer formatting.
 1998-04-04 04:18:06 +00:00
Fred Drake 07bcd99873 Start at updating the template a little bit. There's a lot of stuff that's 
just not here yet.
 1998-04-03 21:25:16 +00:00
Fred Drake 47cfd03dff Increase space between the end of a regexp and the little right floor symbol 
used as a closing quote.  At AMK's request.
 1998-04-03 21:22:31 +00:00
Fred Drake fe03e81aa5 Removed line of obsolete markup. 1998-04-03 20:35:03 +00:00
Guido van Rossum 791468f731 Some clarifications of out-of-range group indexes/names 1998-04-03 20:07:37 +00:00
Fred Drake 61885924b1 Lots of markup consistency nits. 
Logical markup.
 1998-04-03 07:16:46 +00:00
Fred Drake 6251c169c6 Small nits. 
One more index entry.

Be more specific about an exception raised by range().
 1998-04-03 07:15:54 +00:00
Fred Drake 8efde2197b Several minor markup nits. 1998-04-03 07:13:56 +00:00
Fred Drake 9f6aec870e "alternative" is a noun, use "alternate" for the adjective. 
Minor nits.
 1998-04-03 07:12:52 +00:00
Fred Drake 14c198b146 Talk about some minor nits... 1998-04-03 07:11:32 +00:00
Fred Drake 395e8e4860 Capitalize "Python" for consistency. 
Describe UserDict and UserList individually so they aren't too hideous in
the presentation.
 1998-04-03 07:10:41 +00:00
Fred Drake 7932a6bf8c Small markup nits. 1998-04-03 07:09:38 +00:00
Fred Drake d59db4f974 Small consistency nits. 1998-04-03 07:06:56 +00:00
Fred Drake 2123774287 Capitalize "Python" for consistency. 1998-04-03 07:06:01 +00:00
Fred Drake e6cedb362c New index entries. 1998-04-03 07:05:16 +00:00
Fred Drake 3f1c4720b5 Use {methoddesc} as appropriate. 1998-04-03 07:04:45 +00:00
Fred Drake 5dabeed4ea Index entries. 
Consistency nits.
 1998-04-03 07:02:35 +00:00
Fred Drake d0a40cb4cf Added comment crediting Sue Williams with this documentation section (the 
ACKS file should be checked....).
 1998-04-03 06:56:31 +00:00
Fred Drake 55e3cbd115 Fix one typo. 
Add a manpage reference.

Add an index entry.
 1998-04-03 06:54:27 +00:00
Fred Drake 74810d5abb Nits. 
Add {excdesc} for zlib.error.

Use {methoddesc} where appropriate.
 1998-04-03 06:49:26 +00:00
Fred Drake c3486318e0 Add index entry for GzipFile class. 1998-04-03 06:48:16 +00:00
Fred Drake d678cb7a6c Logical markup. 1998-04-03 06:35:54 +00:00
Fred Drake 9fee071ab6 Markup consistency. 1998-04-03 06:21:23 +00:00
Fred Drake 5bfe4850cf Consistency: Don't use module name when referring to functions defined 
in the same module.
 1998-04-03 06:14:54 +00:00
Fred Drake 2cfc835b7b Minor nits. 
Lots of index entries.
 1998-04-03 06:12:21 +00:00
Fred Drake 4e6688747c Consistency nits: 
Use math-mode pi instead of mixing forms.

Use spaces around relational operators.
 1998-04-03 06:04:12 +00:00
Fred Drake 76547c5631 Minor nits. 
Moved IGNORECASE & friends to "top level" definitions following compile(),
since there is no other case of nesting in the manual.

Use {memberdesc} and {methoddesc} as appropriate.
 1998-04-03 05:59:05 +00:00
Fred Drake dff21a6b93 Minor nits. 
Indent code sample to use 4-space indents.
 1998-04-03 05:42:10 +00:00
Fred Drake 16a19c46a9 Mention the --help option to tools/mkhowto.sh. 1998-04-03 05:41:38 +00:00
Fred Drake 5bd7fccef9 Minor nits. 
Index entry.
 1998-04-03 05:31:45 +00:00
Fred Drake a594bafde7 Normalized case rules in section headings. 
Moved stuff from "Recent Additions to 1.1" to "More on Defining Functions".
This means there's now a short section on "Defining Functions" immediately
followed by a long section "More on Defining Functions."
 1998-04-03 05:16:31 +00:00
Fred Drake 7e9d3148d1 Capitalize "Python" for consistency. 1998-04-03 05:02:28 +00:00
Fred Drake 6a79be8db8 Capitalize "Python" for consistency. 
Add an index entry.
 1998-04-03 03:47:03 +00:00
Fred Drake 930f134fc9 Logical markup. 1998-04-03 03:44:56 +00:00
Fred Drake dd1f52b0c4 Use {seealso} environment to refer to the struct module. 
Document ArrayType.

Use {memberdesc} and {methoddesc} environments, as appropriate.

Minor nits.
 1998-04-03 03:35:24 +00:00
Fred Drake 5a52519a6e add_idx(): Restore message to stdout when formatting the general index. 1998-04-02 22:39:05 +00:00
Fred Drake 2b8093ab96 Match python.sty a little better. 1998-04-02 22:33:44 +00:00
Fred Drake 537149707b Removed an obsolete hack that's been commented out for a long time. 
Added comments to various sections.
 1998-04-02 22:33:16 +00:00
Fred Drake 1191692d3d Lots of little nits. 
Big fix:  the module index for the Python Library Reference is once more in a
separate file!  Yeah!
 1998-04-02 22:30:57 +00:00
Fred Drake 58b2bfd0bf This fixes a (minor) problem discovered by AMK when you don't want any 
special markup for the first column of a table using {tableii} or {tableiii}.
In LaTeX, this requires using "textrm" as the formatting function, and this
is needed to remove the bogus "<textrm>" that gets generated otherwise.
There should probably be a more general mapping of specified markup to useful
markup, but that doesn't appear needed at the moment.

do_env_tableii(), do_env_tableiii():  If the markup for the first column is
	\textrm, make it empty.

do_cmd_lineii(), do_cmd_lineiii():  If the markup for the first column is
	empty, don't add markup around the text.
 1998-04-02 20:14:04 +00:00
Fred Drake 3a18f3ba38 Hyphenate "built-in" for consistency. 1998-04-02 19:36:25 +00:00
Fred Drake dc40904a32 Hyphenate "built-in" for consistency. 1998-04-02 18:54:54 +00:00
Fred Drake da70ee1fae Use methoddesc and memberdesc, as needed. 
Added description of BastionClass, since it is referred to in the Bastion
description as subclassable.
 1998-04-02 18:51:30 +00:00
Fred Drake 182bd2d176 Use methoddesc instead of funcdesc to describe the only method. 1998-04-02 18:50:21 +00:00
Fred Drake 2351c80747 \bifuncindex: Fix so entries combine correctly with those of the built-in 
functions section.
 1998-04-02 18:48:32 +00:00
Fred Drake 0a73d4db51 Removed reference to ni module. 1998-04-02 18:46:44 +00:00
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
Fred Drake 7d20ffe245 Adjust the index inclusion for the new index support. 1998-03-09 16:39:22 +00:00
Fred Drake 568113a75b Obsolete. 1998-03-09 16:38:32 +00:00
Fred Drake 8bc965785e Adjust index file resetting; just remove the files. The new index support 
doesn't fail if the files don't exist.

Use makeindex for the module index.
 1998-03-09 16:37:52 +00:00
Fred Drake b390daf704 Adjust the index support a bit to make it easier to deal with module index. 
Don't generate the mod???.idx file if it wasn't requested with the new command
\makemodindex.

Change the format of mod???.idx to match that of "normal" .idx files.  This
lets us use makeindex for it and not need a special script.
 1998-03-09 16:35:36 +00:00
Fred Drake 8fcad7beb1 Don't generate a \label{} here. 1998-03-09 14:48:00 +00:00
Fred Drake 2eda4ca4df Markup adjustments. 1998-03-08 08:13:53 +00:00
Fred Drake cd14a87c02 Mark the journal title. 1998-03-08 08:02:58 +00:00
Fred Drake 23bc85a8a6 Correct spelling of emdash. 1998-03-08 07:56:48 +00:00
Fred Drake 7ddd043191 Moved solitary "see also" paragraph into a {seealso} environment, and told 
why the reader should see also.
 1998-03-08 07:44:13 +00:00
Fred Drake 013ad9869e Cleaned up some remaining markup nits. 
Andrew:  In description of (?iLmsx), you say it matches the empty string and
sets the corresponding flag.  Is this correct?  Or does it only set the flag?
 1998-03-08 07:38:27 +00:00
Fred Drake 8fab8cf211 Logical markup. 1998-03-08 07:14:20 +00:00
Fred Drake b991f8d2e0 Some logical markup. 1998-03-08 07:09:19 +00:00
Fred Drake b55f9d3dfc Small nits. 
Don't run into the right margin.
 1998-03-08 07:03:27 +00:00
Fred Drake cc444e39e5 Nits. 1998-03-08 06:47:24 +00:00
Fred Drake bccc64020e Logical markup. 
Spell emdash right.
 1998-03-08 06:41:57 +00:00
Fred Drake 0c2af2bef6 Spell emdash with three hyphens. 
Minor nits.
 1998-03-08 06:28:00 +00:00
Fred Drake 266b4c1506 Logical markup. 
Index entry.
 1998-03-08 06:12:10 +00:00
Fred Drake c07ae9f4d2 Some logical markup. 
Combine function pairs:  add() and __add__() go together.  This way they
share a single description and use less space.
 1998-03-08 05:56:15 +00:00
Fred Drake 0fd72ee369 Logical markup. 
Don't prepend the module name when referring to functions or data in the same
module.

Correct the description of "modules".
 1998-03-08 05:43:51 +00:00
Fred Drake 580eb26044 Logical markup, a couple of index entries. 1998-03-08 05:41:11 +00:00
Fred Drake 2c954fa411 Remove info targets from "world" and "tarballs". 
This is because it's not working again; the optional arg. for \seemodule{}
is not yet supported.
 1998-03-07 19:59:45 +00:00
Fred Drake 473a90e831 Allow the user to specify the "biggest" section type from the command line; 
default is "chapter".  Use 'python toc2bkm.py -c section' to use with
Python HOWTO documents.
 1998-03-07 15:34:50 +00:00
Fred Drake cd05ca9762 Remove unnecessary blank line in long code sample. 
Remove a confusing article.
 1998-03-07 05:32:08 +00:00
Fred Drake 1c8d0e0579 Never, NEVER try to recover a screwed up file by carving a chunk out of an 
RCS ,v archive!  And certainly don't check it back in without testing it.

				;-(

"@" becomes "@@" everywhere.

This one *is* tested!
 1998-03-07 05:29:15 +00:00
Fred Drake 6663b22198 Oops; file copy error somewhere along the way.... 1998-03-06 22:33:06 +00:00
Guido van Rossum 47e09c43fd Change the date to March 6, 1998. 
Migration to Frame 5.5.

Checking in the PDF file.  (This is questionable -- but we check in the
Postscript as well.  Perhaps *both* should be removed from the CVS tree,
now everything is unbundled and we're distributing PS and PDF tarballs?)

Note -- the HTML generation using webmaker is currently broken.  I'll
have to look into generating HTML from Frame...
 1998-03-06 21:43:09 +00:00
Fred Drake 1e9be5dbdd Relocating file to Doc/texinputs. 1998-03-06 21:30:41 +00:00
Fred Drake e4837a1671 Revised Makefile to handle the new directories correctly. 1998-03-06 21:29:34 +00:00
Fred Drake 361ee6582a Utility to help create outline information for PDF. 1998-03-06 21:29:00 +00:00
Fred Drake 1546fc3e10 Relocating file to Doc/tools. 1998-03-06 21:28:28 +00:00
Fred Drake 4074896a1e Add reference to the copy_reg module in the See Also: section. 1998-03-06 21:27:14 +00:00
Fred Drake ebcb658248 Revise some of the PDF support to get at least preliminary outline support. 
Rewrite \seemodule (again) to allow an optional argument to support modules
which include an underscore in the names.  See example in comments.
 1998-03-06 21:25:17 +00:00
Fred Drake 8f9728b8da Ignore *.bkm files. 1998-03-06 21:22:34 +00:00
Fred Drake dbe132c7ac LaTeX class for Python HOWTO documents. 1998-03-06 21:21:56 +00:00
Fred Drake 6f7398b97b Relocating file to Doc/perl. 1998-03-06 21:20:37 +00:00
Fred Drake b3c9bca242 Misc. revisions to LaTeX2HTML support. 1998-03-06 21:20:08 +00:00
Fred Drake bc7101dff0 Relocated .latex2html-init to l2hinit.perl. 
howto.perl is new; supports LaTeX2HTML for HOWTO documents.
 1998-03-06 21:18:55 +00:00
Fred Drake bc772f466c Moved & renamed to perl/l2hinit.perl 1998-03-06 21:17:50 +00:00
Fred Drake 2023d38a58 Relocating file to Doc/tools. 1998-03-06 21:16:47 +00:00
Fred Drake 859c797a48 Fix the URL for the regex-to-re HOWTO. 1998-03-06 15:11:30 +00:00
Fred Drake 2135117542 Oops, I *thoughT* I had seen a better address for Andrew.... 1998-03-05 20:06:31 +00:00
Fred Drake 8b8eae3e68 Updated URL & email addresses related to the PCT. 
Andrew, plase check to make sure these are the ones you want used and get
back to me; this stuff will be "published" in the near future.
 1998-03-05 20:04:23 +00:00
Fred Drake 2c0ef4d625 Corrected citation markup in first paragraph. 1998-03-05 19:33:10 +00:00
Fred Drake 55a7cf3ee7 Update documentation release date. 1998-03-05 17:15:26 +00:00
Fred Drake c113745498 For verbatim text, don't bounce down a size. 1998-03-05 17:00:55 +00:00
Fred Drake aa54e2db84 Move the change to ending the abstract from python.sty to manual.cls; it 
is not appropriate for the howto document class.
 1998-03-05 16:41:42 +00:00
Fred Drake e61d7af4db latex-$(VERSION).tar.gz, tarlatex: Create the source distribution. 
clean:  Remove all the generatable tarballs.
 1998-03-05 16:37:34 +00:00
Fred Drake 2888bf6cb9 Build a tarball that extracts to Python-$VERSION/Doc/ instead of Doc/, 
at Guido's suggestion.
 1998-03-05 16:31:22 +00:00
Fred Drake 3455edcbc8 Create the module index only if a conditional is true. 1998-03-04 21:56:42 +00:00
Fred Drake 54b03b85f7 Define a new conditional, use this to control creation of module index 
data file.
 1998-03-04 21:52:33 +00:00
Fred Drake 28f1391051 Improve separation of document class and python semantic constructs. This 
will allow us to have a class of smaller documents as well.
 1998-03-04 21:47:59 +00:00
Fred Drake c7e76c885b Remove item on migration to LaTeX2e document classes. Done. 1998-03-04 17:35:00 +00:00
Fred Drake 85551a38f3 tarballs: Ok, we do support info for the moment, so add that to the tarballs 
target.
 1998-03-04 16:51:36 +00:00
Fred Drake b1cd7710ef pdf-$(VERSION).tar.gz: If ref/ref.pdf exists, include it in the tarball 
along with the others.

html-$(VERSION).tar.gz:  Change the wildcard for picking up GIFs a little
	to avoid changes in what LaTeX2HTML generates.
 1998-03-04 16:49:36 +00:00
Fred Drake 71472a5f20 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) 
Add comments about what to do about bugs.
 1998-03-04 15:21:02 +00:00
Fred Drake cefcb33d4e Oops, remove some debugging prints. 1998-03-04 06:34:21 +00:00
Fred Drake b98cd39e20 changeit(): Added support for \deprecated{}. 
Chunk.__repr__(), main():  Allow Chunk objects to get the buffer, to make the
representation contain text instead of a pair of indexes.  This makes debugging
a little easier.
 1998-03-04 06:33:43 +00:00
Fred Drake 34d6f5b0be Preliminary LaTeX2HTML 98.1p1 support. Includes patch from Ross Moore to 
get some funky quoting of ']' in \item[...] to work right without having to
do really ugly things to the documents themselves.

There are a lot of things relating to indexing that are commented out;
parts need to be examined and dealt with with respect to changes in
LaTeX2HTML internals.  I'll work with Ross to see what it takes to make
this sort of stuff reasonable.
 1998-03-04 05:36:59 +00:00
Fred Drake 2da947af87 Comment out the attempt to get index-related stuff processed in the right 
order.  LaTeX2HTML just doesn't do things the same way as LaTeX, and this
wasn't the fix.

Simplify the generated HTML for \file{}.

For \samp{}, use "..." instead of `...'; many fonts make that look pretty
bad.   ;-(
 1998-03-04 05:30:49 +00:00
Fred Drake 3fe985fc28 Simplify some of the escaping around ']' in \item[...] markup in light of 
a fix to LaTeX2HTML from Ross Moore.  Yeah!
 1998-03-04 03:51:42 +00:00
Fred Drake 12577abe2e For each of the l2h??? targets, remove the sed hack that rips out a comma; 
it no longer appears to be needed.
 1998-03-03 22:39:37 +00:00
Fred Drake 986c100735 Perish Evil Revelry and Lamentation. 1998-03-03 22:27:28 +00:00
Fred Drake 49d9b620a1 Obsolete. 1998-03-03 22:03:08 +00:00
Fred Drake 6659c30b67 Convert LaTeX support to create a new class of documents. HTML generation 
now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress).

This means that doing things to change the formatting of the manuals (at the
"normal user" level, like A4 paper), can happen in just one place, rather
than in each document file.
 1998-03-03 22:02:19 +00:00
Fred Drake 53525379da Logical markup. 1998-03-03 21:56:15 +00:00
Fred Drake 34eefe59f2 Overhaul. 1998-03-03 21:41:22 +00:00
Fred Drake 40e72f7fbd Fix typo. 1998-03-03 19:37:38 +00:00
Fred Drake 4ad89bfe68 Nit for \refexmodindex{} (reference to extension module). 1998-03-03 18:52:55 +00:00
Fred Drake 791f2ae1fe Simplify the parameters passed to node2label.pl. 1998-03-03 18:05:13 +00:00
Fred Drake d7bb3032c1 Marked reference to the Python Library Reference with \emph{}. 
Changed sample module creation of an exception to use PyErr_NewException().

Logical markup.
 1998-03-03 17:52:07 +00:00
Fred Drake fcf275e0be Script to create a source distribution. See comments at top. 1998-03-03 17:22:44 +00:00
Fred Drake f611d37647 Ignore tarballs. 1998-03-03 17:14:23 +00:00
Guido van Rossum 9bdc436aaa Added msvcrt. 1998-03-03 02:00:14 +00:00
Fred Drake f7cfb9a7a7 &replace_verbatim, 
&replace_verbatim_hook:  Clean up a little, avoid long lines.
 1998-03-02 16:43:59 +00:00
Fred Drake 10026de6a3 Make the title page include all the interesting information. 1998-02-27 22:13:13 +00:00
Fred Drake ec9200a2fe &do_cmd_deprecated: New function. 
Attempt to get \setindexsubitem{} handled at the right time under LaTeX2HTML
98.1; should still be fine under 97.1*.
 1998-02-27 16:56:55 +00:00
Fred Drake 05073e99ab Update. 1998-02-27 16:21:58 +00:00
Fred Drake 92e31944f4 Deprecate the read() and write() methods. 
Don't refer to them from the fromfile() and tofile() methods.
 1998-02-27 16:21:31 +00:00
Fred Drake 26c73b7841 Added semi-structured support for feature deprecation. 1998-02-27 16:20:30 +00:00
Fred Drake f9fd4e8828 Put all the indexsubitem stuff together. 
Support modified verbatim for both LaTeX2HTML 96.1* and 98.1.

Make table column headers bold.
 1998-02-27 15:28:45 +00:00
Fred Drake 7186783f56 Make table column headings bold. 1998-02-27 15:20:20 +00:00
Fred Drake 8a13525274 Updates by AMK. 
Markup corrected, logical markup.
 1998-02-27 15:19:42 +00:00
Fred Drake 4f56f2d646 When "declaring" a module using \*modindex{}, and * doesn't start with "ref", 
set up the indexsubitem to "(in module #1)" automatically.  This reduces the
amount of markup needed in the module docs and, more importantly, makes it
o.k. to leave out in simple sections.  \setindexsubitem{} can still be used
to change or reset it.
 1998-02-27 14:54:06 +00:00
Fred Drake 8fa5eb8784 Logical markup. 1998-02-27 05:23:37 +00:00
Fred Drake c865eb0587 Nit to prevent empty node in formatted version. 1998-02-27 05:21:36 +00:00
Fred Drake e65bb4e914 Reformulate how the info stuff is ignored. 1998-02-27 05:20:59 +00:00
Fred Drake 4f4e920889 Use a Python script to create "empty" indexes. This solves Guido's 
corrupted file problem and avoids the shell escape interpretation
portability problem.  ;-(  See comments at top of newind.py for an
explanation.
 1998-02-27 05:18:28 +00:00
Fred Drake bdab730cf3 Update.... 1998-02-27 02:23:15 +00:00
Fred Drake f39ed67fa2 Added \label{}s for logical addressing. 1998-02-26 22:01:23 +00:00
Fred Drake 6c2176eea7 Added \label{}s for logical addressing. 1998-02-26 21:47:54 +00:00