Commit Graph

2636 Commits

Author SHA1 Message Date
Fred Drake 64583d3f87 Rename the parameters of atan2(), based on comments from Guido & Peter
A. Koren <pkoren@hex.net>.
1998-12-08 16:10:44 +00:00
Guido van Rossum f484a3366b Sjoerd writes:
When literal mode is entered it should exit automatically when the
matching close tag of the last unclosed open tag is encountered.  This
patch fixes this.
1998-12-07 21:59:56 +00:00
Fred Drake d83675f344 "singed" --> "signed" (3 places)
Noticed by Andrew MacIntyre <andymac@bullseye.apana.org.au>.
1998-12-07 17:13:18 +00:00
Guido van Rossum e039439e3b Clarify evaluation of default arguments at def time with more text and
an example.
1998-12-04 19:37:10 +00:00
Guido van Rossum 8c2da61811 Add explicit example on how to import a submodule of a package using
__import__ and getattr().
1998-12-04 15:32:17 +00:00
Fred Drake 86bc7b01b5 General comments on what's here and how to try it out. Note
dependence on the XML package.
1998-12-02 17:21:35 +00:00
Barry Warsaw 6d26f4b188 Moved NotImplementedError into alphabetical order, and reword
description.
1998-12-01 19:48:04 +00:00
Barry Warsaw 1e151322fb Added documentation for NotImplementedError. Fred (I'm sure) will
sanitize for your protection :-)
1998-12-01 19:19:21 +00:00
Fred Drake 3695b1212c Support conversions to both SGML and XML; SGML is the "default".
Add dependency on esistools.py for the ESIS intermediate files.
1998-12-01 19:05:56 +00:00
Fred Drake aeea9810cd Use esistools.
Lots of changes to the conversion table.
1998-12-01 19:04:12 +00:00
Fred Drake 4db5b4636c Use esistools.
Generate ESIS data instead of XML.
Misc. changes to some transforms.
1998-12-01 19:03:01 +00:00
Fred Drake f077b9d61f Use esistools, getopt. 1998-12-01 19:01:53 +00:00
Fred Drake 3843bae969 Utility functions and misc. classes used in handling ESIS data. 1998-12-01 19:00:58 +00:00
Fred Drake 2f8592cbea Ignore the byproducts of SGML/XML conversions for now. 1998-12-01 18:58:28 +00:00
Fred Drake eabfab1048 Nits to support conversions. 1998-12-01 18:37:59 +00:00
Fred Drake 1e270f0e03 Nits to support conversions. 1998-11-30 22:58:12 +00:00
Fred Drake f954b6516e Remove $(CUTCRUFT) garbage; now in fixgenents.sh.
Separate ESIS generation from XML generation.  This will evolve a bit
more in a couple of days.
1998-11-30 22:31:45 +00:00
Fred Drake 3d5e2c032d Move nasty cruft from make.rules' $(CUTCRUFT) here, mostly to clean up
make.rules.
1998-11-30 22:30:29 +00:00
Fred Drake 50b804dc88 Fix minor nit with respect to conversion.
Update some logical markup.
1998-11-30 22:14:58 +00:00
Fred Drake caa3379c4f Remove {\rm ...} constructs. 1998-11-30 21:53:47 +00:00
Fred Drake 84538cd076 Remove some remaining {\rm ...} constructs.
Update logical markup in a few spots.
1998-11-30 21:51:25 +00:00
Fred Drake f790b16d00 Change "for" explanation slightly based on comment passed along by
Blake Winton <BlakeW@pcdocs.com>.
1998-11-30 20:37:24 +00:00
Fred Drake ca6d6355d7 l2hoption: Do the "right thing" to quote the right-hand-side of Perl
assignments.  This allows '"', '$', and '@' to be included in
	the values passed to parameters like --address.
1998-11-30 20:30:26 +00:00
Fred Drake a8ba364700 Add a --address parameter to the mkhowto command line to direct
documentation comments appropriately.  In response to comment from
Martijn Faassen <faassen@vet.uu.nl>.

Add dependency to about.dat.
1998-11-30 20:28:35 +00:00
Fred Drake 7777e36c21 Add a -address parameter to the LaTeX2HTML command line to direct
documentation comments appropriately.  In response to comment from
Martijn Faassen <faassen@vet.uu.nl>.
1998-11-30 20:27:31 +00:00
Fred Drake 1ea5848b7b Oops, remove LaTeX2HTML version number. Could become wrong and isn't
needed, since it's always added to the comments in the page header
anyway.
1998-11-30 19:29:34 +00:00
Fred Drake 15796f791a do_cmd_textohtmlinfopage(): Rip out most of the boilerplate and move
it to the about.dat file.  Only what really needs to be
	generated is, and the remainder is easier to maintain than
	Perl code.
1998-11-30 19:25:47 +00:00
Fred Drake d83c8bd95f New file. Contains boilerplate text for the "About this document..."
section of LaTeX2HTML-generated documents.

Includes credit to Christopher Petrilli for the navigation icons.
1998-11-30 19:24:13 +00:00
Fred Drake 1776556f8f Markup nit to ease conversions. 1998-11-30 19:00:16 +00:00
Fred Drake 3d29955a6e Markup improvements to help with conversions. 1998-11-30 18:59:44 +00:00
Fred Drake 01d5d94020 Remove cruft from the old Texinfo conversion. This simplifies some of
the newer processing.
1998-11-30 17:33:38 +00:00
Fred Drake 5208823158 Remove bogus \@. 1998-11-30 16:27:37 +00:00
Fred Drake d61975e179 Minor markup nit to ease conversion processing. 1998-11-30 16:26:50 +00:00
Fred Drake f6c59e8fff Do all the right imports. Problem reported by Martijn Faassen
<faassen@vet.uu.nl>.
1998-11-30 15:07:26 +00:00
Fred Drake 42f5298ab5 Several small adjustments. 1998-11-30 14:45:24 +00:00
Fred Drake fa1cceb91f Make \var work correctly in math mode. 1998-11-30 14:42:59 +00:00
Fred Drake 87dfd3cfbf Handle output of \geq and \leq. 1998-11-30 14:36:26 +00:00
Fred Drake 4471f20ed4 Logical markup.
Fix a few things for the conversion to structured markup.

Removed texinfo special cases, since there's likely a new info
process.
1998-11-25 22:38:24 +00:00
Fred Drake f65e323101 Fix remaining {\rm ...} construct. 1998-11-25 20:55:03 +00:00
Fred Drake af2590a991 Remove some optional parameters that are unnecessary in context. 1998-11-25 20:15:52 +00:00
Fred Drake 72554e476f Remove bogus \@. 1998-11-25 20:07:35 +00:00
Fred Drake b6d45c6ad1 Remove bogus \@. 1998-11-25 19:55:47 +00:00
Fred Drake 4c5e533693 Do the right stuff to convert what was originally \e, \ldots, and ---
in the LaTeX sources.
1998-11-25 19:28:02 +00:00
Fred Drake d03268feaa Remove two remaining {\tt ...} constructs. 1998-11-25 19:23:33 +00:00
Fred Drake 78eebfdbf4 Remove two remaining {\tt ...} constructs. 1998-11-25 19:09:24 +00:00
Guido van Rossum 5eabf3823b Clarify that min and max also take multiple arguments. 1998-11-25 18:53:05 +00:00
Fred Drake 1e42d8aaab Massive change to just about every construct that impacts the index.
Blame it on Just.  ;-)
1998-11-25 17:58:50 +00:00
Fred Drake ea81edf059 Markup nits.
Fixed an index entry, added three more.
1998-11-25 17:51:15 +00:00
Fred Drake 1475e88a35 Minor fixups to some index entries. 1998-11-25 17:48:10 +00:00
Fred Drake 2b3730e284 Minor adjustments to a few index entries. 1998-11-25 17:40:00 +00:00
Fred Drake 1cbd196f96 Minor nit that fixes a bunch of indexing: the way the classdesc
environment saves the name of the last class described, method and
member descriptions were not picking it up correctly.  Thus, many
index entries were described as "( method)" instead of "(FooClass
method)".  Multiple entries were collapsed in the index when
methods/members from multiple classes share the same name.
1998-11-25 17:13:28 +00:00
Fred Drake e839199014 Fix indexing of func_code attribute; this is on a function, not a code
object.

Add "()" to method names indexed using \ttindex{}.
1998-11-25 17:09:19 +00:00
Fred Drake d8faf85d40 Supplemental rules to convert a .tex file to a .xml file. Both XML and
SGML will be supported soon, probably using an ESIS representation saved
in a temp file.
1998-11-24 17:40:33 +00:00
Fred Drake 6942e57f87 Script to convert things like <C/> and <Cpp/> to &C; and &Cpp;. This is
something that con't be done with the DOM as far as I can tell.
1998-11-24 17:38:49 +00:00
Fred Drake e743fd01ac Rationalize a word-space markup to not break in the LaTeX->*ML
conversion tools currently being constructed.

Add a chapter from Jim Fulton on using Misc/Makefile.pre.in.  Still
preliminary.  The "Dynamic Loading" chapter needs to be updated (and
possibly removed, since it's no longer an issue for most (any?)
users.
1998-11-24 17:07:29 +00:00
Fred Drake 1cb330c383 The & character is also escaped using \. 1998-11-23 23:11:12 +00:00
Fred Drake 1ff6db484f Add some additional cleanup transformations. 1998-11-23 23:10:35 +00:00
Fred Drake 5701482ea7 Fix comment regex so we don't screw up structured comments with
different internal indentation levels.
1998-11-23 18:21:54 +00:00
Guido van Rossum 04307ce789 Rewrote the section on sys.exit(), documenting other argument types
than integers and recommending sys.exit("message").
(I see this as Python's answer to Perls ``die "message";''.)
1998-11-23 17:49:53 +00:00
Fred Drake 0320473a29 Script to squirrel around with the DOM tree of document fragments from the
LaTeX-based ESIS streams to be a little better structured, and generally
perform clean-up.

Preliminary.
1998-11-23 17:02:03 +00:00
Fred Drake 30a68c7a2b Moved into tools/sgmlconv/. 1998-11-23 16:59:39 +00:00
Fred Drake 63de8f6d55 Moving to sgmlconv/ subdir. 1998-11-23 16:58:48 +00:00
Fred Drake bbd7509dbe Fix up the extraction of optional parameters a little.
Be more informative in an exception message.
1998-11-23 16:30:18 +00:00
Fred Drake c16149b17b Some cleanup.
Don't duplicate the information on what's empty; rely on the input
data for that.  (This means that the DOM may need more work.)
1998-11-23 15:14:18 +00:00
Fred Drake 96b07a9453 Fix some minor problems.
Make the table of attribute information contain only one kind of
entry.  Simplifies some stuff in subconvert().
1998-11-23 15:12:00 +00:00
Fred Drake 99ff8c4361 First cut at a script to generate SGML/XML from an ESIS event stream,
probably only usable for the Python docs.  But also probably more
useful than latex2esis.py.
1998-11-18 23:28:24 +00:00
Fred Drake 95f4f92b47 First cut at a script to generate ESIS events from LaTeX source,
probably only usable for the Python docs.
1998-11-18 23:27:24 +00:00
Fred Drake db70d06464 Eliminate remaining \verb/.../ constructs; there's no need for them. 1998-11-17 21:59:04 +00:00
Guido van Rossum da30f4ca6b Fix typo in doc for handle(): client_request should be client_address.
Noted by Stefan Witzel.
1998-11-16 19:07:04 +00:00
Fred Drake 5e8aa549d1 Update the example in "Calling Python Functions from C" to use
METH_VARARGS conventions and PyArg_ParseTuple(), and document the flag
and where to look for PyArg_ParseTuple() info.

Response to comment from Don Bashford <bashford@scripps.edu>.
1998-11-16 18:34:07 +00:00
Fred Drake c46973c89b Document the user and password parameters to the NNTP constructor. 1998-11-16 17:11:30 +00:00
Fred Drake 2510d22048 Clarify the default buffering for open(). (Comment from Andrew Dalke
<dalke@bioreason.com>).
1998-11-02 18:57:34 +00:00
Fred Drake cab91efd34 Fix Barry's markup. 1998-11-02 17:23:25 +00:00
Guido van Rossum a096a2e6a2 Warn that AddModule doesn't import the module. 1998-11-02 17:02:42 +00:00
Fred Drake 9ed1a0afb9 Moved zmod and poly descriptions to the Obsolete section. 1998-11-02 15:46:21 +00:00
Barry Warsaw 4a1cdd7f22 Document the new features of this module 1998-10-31 23:19:00 +00:00
Fred Drake 130072d663 Don't describe something as "below"; that won't make sense for the
HTML version.  Give a reference to the actual section to allow a
hyperlink to be built.
1998-10-28 20:08:35 +00:00
Fred Drake c024c99faf Fix typo reported by Gerry Weiner <gerry@ucar.edu>. 1998-10-28 18:19:16 +00:00
Andrew M. Kuchling c1cea208bc Added URL to HOWTO page, with reference to Regex HOWTO.
Corrected error: {,5} is not equivalent to {0,5}.
1998-10-28 15:44:14 +00:00
Fred Drake 566b6d5b59 Support the use of bibtex. This is transparent to the user.
Switch from bash to ksh, in the hope that more systems support it (one
report of a site without an available bash).
1998-10-27 21:59:03 +00:00
Guido van Rossum 04101960e6 Indicate that os.environ may not be a real dictionary. 1998-10-24 20:16:56 +00:00
Guido van Rossum c62cf36e76 The last two example functions in the section about default argument
values (4.7.1) should return l, not a.  Reported by Axel Boldt.
1998-10-24 13:15:28 +00:00
Fred Drake 803b340888 Update the date. 1998-10-21 14:50:52 +00:00
Fred Drake a76b63c4f4 Bump the release to 1.5.2a2. 1998-10-21 14:49:48 +00:00
Fred Drake d29cf379b9 Added --tools option, to package only the framework (no documents). 1998-10-21 14:26:26 +00:00
Fred Drake 9beee80fd7 Remove a couple of unnecessary "%" characters that cause problems with
the latest latex2html beta.
1998-10-21 00:44:49 +00:00
Fred Drake dad11321eb Remove a bunch of unnecessary "%" characters that cause problems with
the latest latex2html beta.
1998-10-21 00:26:56 +00:00
Fred Drake 3041b0715b Remove an unnecessary "%" character that seems to cause a minor glitch
with the latest latex2html.
1998-10-21 00:25:32 +00:00
Fred Drake 28e7b4cce1 add_link(): Fix to use $section_info instead of $toc_section_info,
based on email from Ross Moore <ross@mpce.mq.edu.au>.

Set $HTML_VERSION to 4.0, since that's what we really generate (well,
4.0 "transitional").
1998-10-20 18:14:20 +00:00
Fred Drake fbddddee49 Reflect new name of index style file. 1998-10-19 21:48:05 +00:00
Fred Drake 7f77db9530 Renamed myindex.ist to something more reasonable. 1998-10-19 21:45:52 +00:00
Fred Drake 9dcc9f7764 No longer needed since we have nice, contributed navigation buttons. 1998-10-19 21:40:45 +00:00
Fred Drake a5de730d2d If building HTML and the icons should be served from the same
directory as the HTML (--iconserver .), copy the icons into place.

Clarify that lynx is needed for --text in the usage message.

Fix a typo in a comment.
1998-10-19 19:14:42 +00:00
Fred Drake 649e8c1f7f ArabictoRoman(): Removed, since it wasn't used anywhere. 1998-10-19 16:33:06 +00:00
Guido van Rossum 18fa7d2800 Typo: JIFF -> JFIF. 1998-10-19 13:30:01 +00:00
Guido van Rossum 0a0f11b6d4 PyMapping_SetItemString() returns int, not an object. 1998-10-16 17:43:53 +00:00
Fred Drake b521095952 In build_html(), strip off leading "./" from filename, added by
kpsewhich.  This caused a problem with the latest latex2html beta.
1998-10-16 17:34:34 +00:00
Guido van Rossum f35b884c91 Clarify that close() of a stream opened by popen() returns None if the
exit status is zero.
1998-10-15 13:28:29 +00:00
Guido van Rossum 7d447aabbf Moved search and match around so that search is documented first. 1998-10-13 16:03:52 +00:00
Barry Warsaw afd974c2ab Document the new list.extend() method. Interesting enough, the
canonical definition of extend() is very similar to append() except
that the former doesn't list-ify the argument!
1998-10-09 16:39:58 +00:00
Fred Drake 2e23c3125a Make the dependencies really work for the HTML version. 1998-10-07 22:03:45 +00:00
Fred Drake 437ff8600a Change the default split level to not split on marked \paragraph and
\subparagraph sections.  Indicate the default in the --help message.
1998-10-07 16:46:54 +00:00
Fred Drake b0b1900198 If --debug was used, don't delete the temporary .perl file used to
pass options to latex2html.
1998-10-07 16:41:40 +00:00
Fred Drake 8c1e114d1a Don't attempt to add paragraph and subparagraph sections to the PDF
outline.

Work around font-long bogosity caused by ' in docstring.
1998-10-07 14:12:20 +00:00
Fred Drake 09b295754f Remove extra } at end of method description parameters. 1998-10-01 20:43:13 +00:00
Fred Drake c456d36bde Fix encoding of \ in some string literals in the discussion of "raw"
strings.  Reported by Lorenzo M. Catucci <lorenzo@argon.roma2.infn.it>.
1998-10-01 20:41:57 +00:00
Fred Drake 82385872e9 Fix some confusion in the __repr__() and __str__() descriptions.
Reported by Lorenzo M. Catucci <lorenzo@argon.roma2.infn.it>.
1998-10-01 20:40:43 +00:00
Fred Drake d4c3352288 Fix encoding of \n in a couple of places (reported by Lorenzo
M. Catucci <lorenzo@argon.roma2.infn.it>).
1998-10-01 20:39:47 +00:00
Barry Warsaw b2031f72d3 Document that apply() can now take any sequence in argument 2. 1998-10-01 15:35:43 +00:00
Guido van Rossum 9814a943a5 Add warning that on Windows it only works on sockets. 1998-09-28 14:28:38 +00:00
Guido van Rossum 954b9adcd2 Document new urllib features by Eric Raymond. 1998-09-28 14:08:29 +00:00
Fred Drake f4cbb9c7fa Added realclean and distclean targets to match ../Makefile. 1998-09-23 17:37:14 +00:00
Guido van Rossum 5fb2631ff9 Explicitly document the fact that the search method returns a MatchObject.
(Reported by Gary Herron.)
1998-09-21 19:26:16 +00:00
Guido van Rossum 6ac06b39b3 Patch by Greg Stein to document the 'P' flag. 1998-09-21 14:44:34 +00:00
Fred Drake 10a7985565 re.findall(): Mark as added in 1.5.2. 1998-09-18 17:11:49 +00:00
Guido van Rossum 43b655c0ab Get rid of 'ppp' that accidentally crept in. 1998-09-17 17:07:15 +00:00
Guido van Rossum 6442116029 Richard Wolff's changes, documenting his changes to pdb.py. 1998-09-17 15:11:51 +00:00
Fred Drake b7833d3c0c Add a \label to the section "Fancier Output Formatting" (it's referenced from
the KOE docs).

Some markup nits.
1998-09-11 16:21:55 +00:00
Fred Drake d16d4981d1 Markup nits. 1998-09-10 20:21:00 +00:00
Fred Drake d64a40dbc0 do_cmd_methodlineni(): New function, needed because the ref. manual now
actually uses this markup.
1998-09-10 18:59:13 +00:00
Fred Drake 9b134bf716 Added comment about support for rational numbers, and pointer to
Demos/classes/Rat.py.
1998-09-10 18:42:55 +00:00
Fred Drake 7a2f0668e4 Markup nits.
Fixes/index improvements from Michael Ernst <mernst@cs.washington.edu>.
1998-09-10 18:25:58 +00:00
Fred Drake 3494e4a31f Fix typo in URL; reported by Michael Ernst <mernst@cs.washington.edu>. 1998-09-10 17:55:32 +00:00
Fred Drake f9acc59c55 \itembreak,
\itemjoin:  Remove obsolete macros.

\itemnewline:  Rename to \py@itemnewline, since it's only used internally.
1998-09-09 15:27:43 +00:00
Fred Drake 525d7024ab Ignore the generated README file. 1998-08-28 21:34:50 +00:00
Fred Drake 2335a305e5 When building the tarball of the PostScript files, also generate & include a
little README giving the page count of each file when printed.
1998-08-28 21:17:58 +00:00
Fred Drake 7c86c594ea Target to generate a little README file with the page counts of the PostScript
files.
1998-08-28 21:17:07 +00:00
Fred Drake 47f69067d5 Script to generate page counts of the PostScript files. 1998-08-28 21:16:28 +00:00
Fred Drake e1feb8f2dc Support long options that take arguments of the form --option=value as well
as --option value.

Minor nits cleaned up.
1998-08-28 20:21:04 +00:00
Fred Drake d82575d5bf Markup changes in the section on disciplines to match method descriptions
a little better, and produce better HTML.

Add some index entries.
1998-08-28 20:03:12 +00:00
Guido van Rossum f5a80a4a88 Describe what happens when ``raise C, x'' is called where C is a class
and x is not an instance of C (nor of a class derived of C).
1998-08-25 14:45:41 +00:00
Guido van Rossum dbf7956e52 Clarify Y2K behavior when a tuple with a 2-digit date is passed to
mktime() and such.
1998-08-25 14:44:49 +00:00
Fred Drake 607f802886 round(): Mark the second (optional) parameter as optional, since it's
described that way.

setattr():  Clarify that the attribute doesn't need to exist to be set.
1998-08-24 20:30:07 +00:00
Fred Drake c859350fa6 Added some cross-references to the end. 1998-08-24 18:46:14 +00:00
Fred Drake d0421dd448 spoking --> speaking
object whose method this is --> object on which the method operates
1998-08-24 17:57:20 +00:00
Fred Drake 637af13dca There is no <ISINPUT> element, just <ISINDEX>. ;-) 1998-08-21 20:02:06 +00:00
Andrew M. Kuchling 42db27fedc Added an example that uses signal.alarm() to time out an os.open() that
takes too long. This example relies on the fact that raising an
    exception in a signal handler causes the exception to be re-raised
    when the main line of the program resumes execution.  Is this guaranteed
    in CPython, or is this something that just happens to work by accident?

Also fixed a typo.
1998-08-18 19:38:54 +00:00
Fred Drake 664dcd5b5e Clean up the HTML a bit; update the version number. 1998-08-17 14:11:00 +00:00
Fred Drake e7210dad6c Fix arguments for renames(); bug spotted by Oliver Andrich
<oli@rhein-zeitung.de>.
1998-08-17 13:29:06 +00:00
Fred Drake a5aefbad5a Fix markup where C include files get named in <...> form; bug reported by
Lorenzo M. Catucci <lorenzo@argon.roma2.infn.it>.
1998-08-14 17:05:17 +00:00
Fred Drake a0e4b78233 img_tag(): For \n to be interpreted as a newline, the string must use double
quote, not single quotes.  Ugh.
1998-08-14 15:03:48 +00:00
Andrew M. Kuchling d22e25002a Clarify wording in the description of re.split
Simplify the patterns in the examples for re.split
1998-08-14 14:49:20 +00:00
Fred Drake 7cfca6de2b Don't need these anymore.... 1998-08-13 22:05:09 +00:00
Fred Drake 062bc6e598 Do the magic to use the new buttons (with shorter names!) instead of the old
ones.  Get the <IMG> width & height right.  New design for the navigation
bars, including the document title as well as the navigation links/buttons.
1998-08-13 22:03:46 +00:00
Fred Drake 54c52052ce Add l2hinit.perl to COMMONPERL. 1998-08-13 19:03:19 +00:00
Fred Drake 564e444a7c New icons from Christopher Petrilli <petrilli@dworkin.amber.org>.
Cool!
1998-08-13 18:32:35 +00:00
Guido van Rossum 3a5a02f3da Second definition of popen2 should be popen3. 1998-08-13 01:27:01 +00:00
Fred Drake 9f6f0da084 Improved some error messages for command line processing.
Added --all to produce all formats at once.
1998-08-12 18:07:51 +00:00
Fred Drake 00c468b0c5 Added more informaton about the mkhowto.sh script. 1998-08-12 17:53:46 +00:00
Fred Drake 78b8c3d0d6 Oops, the --text option wasn't documented! 1998-08-12 17:52:16 +00:00
Fred Drake c794c38187 Added a comment about not using a symbolic link to access the script. 1998-08-12 17:50:07 +00:00
Fred Drake 697c1c7325 Some minor updates. 1998-08-12 17:13:28 +00:00
Fred Drake eb7fe4f5a1 Massive cleanup: Use Makefiles in subdirs properly, move most of the
detailed build rules to the subdirs.  Allow pretty much every useful target
to be built directly from the top dir (no change in output location).
1998-08-12 17:08:37 +00:00
Fred Drake 07b12f2497 Re-written to actually perform the conversion instead of using a sub-make
with the parent Makefile.  Will also force the auxillary files to be
created if they need to be.
1998-08-12 17:06:03 +00:00
Fred Drake 3069c976cf Update date & version number for release 1.5.2a1. 1998-08-12 17:02:50 +00:00
Fred Drake 06098e45af New Makefile; includes ../paper-letter/Makefile and sets PAPER=a4. 1998-08-12 17:01:27 +00:00
Fred Drake d48d62cabd New Makefile, contains rules for building typeset versions. 1998-08-12 17:00:24 +00:00
Fred Drake 3d865424a7 New makefile which only contains the source dependencies specific to each
document.  The main Makefile will only contain rules and "system" dependencies.
1998-08-12 16:16:49 +00:00
Fred Drake 370f3c9eb6 Bump RELEASE to 1.5.2a1. 1998-08-11 19:38:00 +00:00
Fred Drake f832f4cd34 Clean things up just a bit. 1998-08-11 19:36:35 +00:00
Fred Drake 15c417eb77 Helper script used in creating navigation buttons. 1998-08-11 19:35:03 +00:00
Fred Drake 9f7adc4f22 Get the <IMG> sizes right for the navigation buttons. 1998-08-11 19:33:38 +00:00
Fred Drake a69ada66d0 Ok, blank.pbm is free to go.
The rest of these are new or replaced.  The buttons are now all the same
width.  They have the transparency set right.  They still need the attention
of a designer.  But they work, and we have a real button for the Modules
Index.
1998-08-11 18:52:33 +00:00
Fred Drake 1b9b210abf I think this is the last of them. 1998-08-11 18:50:04 +00:00
Fred Drake 7aac918029 Gosh, there's a lot of them.... 1998-08-11 18:47:26 +00:00
Fred Drake 704be95237 More files never used here..... 1998-08-11 18:42:30 +00:00
Fred Drake e528458155 Icons only needed if using the change control marks, which are bogus. 1998-08-11 18:40:03 +00:00
Fred Drake c83d7cac07 Remove files we never used; l2h would only use these if you use the
special "html" package, which we don't and won't.
1998-08-11 18:31:35 +00:00
Fred Drake af06a0b4ee Use Perl's rename() function instead of system(); there's no need for two
additional processes for each name change!
1998-08-11 18:17:47 +00:00
Fred Drake 211f22c1b1 Added the test package under "Frameworks". 1998-08-11 18:13:31 +00:00
Fred Drake ee9306b610 Template file for \documentclass{manual}. 1998-08-11 17:59:07 +00:00
Fred Drake 0618f5e55b Added step 0: copy this file to <somedir>/lib<module>.tex, and edit the copy. 1998-08-11 17:43:45 +00:00
Fred Drake bd4009493e Updated to reflect recent changes. 1998-08-11 17:41:20 +00:00
Fred Drake 2f343eb5cf Moved to ../templates/module.tex. 1998-08-11 17:30:02 +00:00
Fred Drake 1334147558 Relocating file to Doc/templates. 1998-08-11 17:25:48 +00:00
Fred Drake bd65706fe3 Added new files to the LIBFILES variable. 1998-08-11 15:50:35 +00:00
Fred Drake 5bdf88a364 Removed now-documented modules from the list. 1998-08-11 15:49:09 +00:00
Fred Drake 23f414c539 Added new sections. 1998-08-11 15:47:16 +00:00
Fred Drake e72e1e02fe Documentation for the compileall module. 1998-08-11 15:46:42 +00:00
Fred Drake 4756bb3e54 Documentation for the py_compile module. 1998-08-11 15:46:25 +00:00
Fred Drake 64c105d3d2 Added index entries.
Small markup nits.
1998-08-11 15:18:45 +00:00
Fred Drake f6b6bbceb6 Add a comment explaining that this script is probably not useful outside the
standard Python documentation, since the mkhowto.sh script is.  Let there be
no doubts....
1998-08-11 14:10:40 +00:00
Fred Drake 4d46487fe8 Make sure the icons/ directory is created even if only one document is
converted.
1998-08-11 13:18:52 +00:00
Fred Drake 916f7c1e7c Better check in the date from the last magic-fix-release. ;-) 1998-08-11 13:14:08 +00:00
Fred Drake 6aa5d482fb Control when/where navigation bars will appear: top & bottom of each page.
Include an additional button to the module index in the nav. bars if we
generate a module index.  Still need a button image, but the ALT text should
do for now.
1998-08-11 03:14:50 +00:00
Fred Drake bc74ca5203 Add a link to the Macintosh Module Reference here, too. 1998-08-10 21:48:31 +00:00
Fred Drake 295da24eaf New section header style.
Fix up a few synopses.
1998-08-10 19:42:37 +00:00
Fred Drake 62e436955b do_cmd_moduleauthor(),
do_cmd_sectionauthor():  Parallel the new macros.
1998-08-10 19:40:44 +00:00
Fred Drake b75c615389 \moduleauthor,
\sectionauthor:  New macros to record attributions; no output.
1998-08-10 18:41:43 +00:00
Fred Drake c817e27501 New style section headers. 1998-08-10 18:40:22 +00:00
Fred Drake 23329d41bc Some logical markup, some nits. 1998-08-10 17:46:22 +00:00
Fred Drake 4d10b43c26 insert_index(): Take two additional parameters: $columns and $letters. Call
buildindex.py appropriately.

add_idx(),
add_module_idx():  Add the appropriate parameters to the calls to
	insert_index().
1998-08-07 20:51:58 +00:00
Fred Drake 077fffa874 The letter headings must be requested explicitly with --letters. 1998-08-07 20:49:54 +00:00
Fred Drake aa3f9fb7d5 By default, use a two-column index. 1998-08-07 19:52:37 +00:00
Fred Drake 7cbf462acf Allow multi-column indexes to be produced. 1998-08-07 19:50:13 +00:00
Fred Drake 66da9d69fc re is standard, not built-in. 1998-08-07 18:57:18 +00:00
Guido van Rossum ed9dcc10f8 Clarify that the Python interpreter lock need *not* be held by
PyInterpreterState_New() and PyThreadState_New() -- but that you may
use it to serialize calls to them.
1998-08-07 18:28:03 +00:00
Guido van Rossum cdf6af1233 Document gethostbyname_ex(). 1998-08-07 18:07:36 +00:00
Fred Drake 96e11029b8 Updated list of Library Reference files.
Added some dependencies to some of the HTML generation targets.
1998-08-07 18:01:37 +00:00
Guido van Rossum aee5e26f4b Add warning that mutable argument defaults are evaluated only once;
with examples and workaround.  This keeps coming up, and I believe
that this section in the tutorial may have been (in part) the source
of the confusion.  While it didn't show examples with [] for a default,
it also didn't emphasize enough why that would be a bad idea, and
while it did say that defaults are evaluated at the point of function
definition, the example was not relevant for this issue.
1998-08-07 17:45:09 +00:00
Fred Drake 1a0b872665 At least mark the URL to the Packages essay using \url. 1998-08-07 17:40:20 +00:00
Fred Drake 5ee808db51 Fix synopsis. 1998-08-07 17:37:15 +00:00
Guido van Rossum 730d83797e Clarify that quit() and close() render the instance useless. 1998-08-07 17:36:59 +00:00
Fred Drake 161edc29a6 Added file transfer to example. 1998-08-07 17:30:49 +00:00
Fred Drake 0cb76200ef Guido's white background. 1998-08-07 16:43:29 +00:00
Barry Warsaw 92a6ed9940 Minor refilling of a paragraph... 1998-08-07 16:33:51 +00:00
Fred Drake 70da192f63 im_function --> im_func 1998-08-07 16:28:13 +00:00
Fred Drake 60c3cafc24 In the example, make sure all the imports are done. 1998-08-07 16:03:32 +00:00
Fred Drake 3700b6f94e Markup nits. 1998-08-07 16:02:28 +00:00
Fred Drake c18a6f3bfe Clarify xdrlib synopsis. 1998-08-07 16:01:15 +00:00
Fred Drake 2d62395a8e Fix typo in binascii synopsis. 1998-08-07 16:00:30 +00:00
Fred Drake 150ee43c64 Removed obsolete chapter header. 1998-08-07 15:58:54 +00:00
Fred Drake f44c4851e9 New organization of internet modules into protocols/support and data
chapters.
1998-08-07 15:58:31 +00:00
Fred Drake 29fe944787 New chapter headers for Internet Protocols and Internet Data chapters,
which replace the existing internet chapter.
1998-08-07 15:56:52 +00:00
Fred Drake d795c5cbd1 Fix synopsis for multifile. 1998-08-07 15:55:14 +00:00
Fred Drake 399fea89cb Shorten the module synopsis. 1998-08-06 21:30:32 +00:00
Fred Drake 72d157e998 Shorten the module synopsis. 1998-08-06 21:23:17 +00:00
Fred Drake 9940bd717c Variant of AMK's patch to produce text versions of HOWTO documents.
This ensures that the text version uses latex2html's -split 1 option, without
affecting HTML produced in the same run, and also minimizes the number of
l2h runs needed if --split 1 was used for an HTML run.
1998-08-06 20:15:20 +00:00
Fred Drake 23a163454a Markup nit. 1998-08-06 15:33:55 +00:00
Fred Drake 1a3c2a0ede Markup nits. 1998-08-06 15:18:23 +00:00
Fred Drake 56fa8a7e4b Marked makedirs(), removedirs(), renames() as added in 1.5.2. 1998-08-06 13:45:42 +00:00
Fred Drake 11300cc71e build_html(): Simplify, so there's only one version of the latex2html
command line.

l2hoption():  Convenience function, to write out an option to the aux. init.
	file only if set.

Added --iconserver option to set the $ICONSERVER variable in latex2html; this
requires the use of an auxillary init. file since this can't be initialized
using a standard latex2html command-line option.  So the aux. init. file is
used for just about all the special options since it has to be written anyway
when $ICONSERVER needs to be set.
1998-08-05 04:48:18 +00:00
Fred Drake 1ca8fdc446 Remove modified setting of $ICONSERVER; this isn't the right way to do it. 1998-08-05 04:36:09 +00:00
Fred Drake 45f2601cf3 get_chapter_id(): Separate two aspects of string replacement to allow the
need for each to vary independently.
1998-08-04 22:07:18 +00:00
Fred Drake f54556efae Fixed wrapping on some long lines. 1998-08-04 20:53:55 +00:00
Fred Drake 3f7b6fcea0 Ok, we'll try this again: update the release date. ;-( 1998-08-04 17:01:18 +00:00
Fred Drake 228e31eef9 Update the documentation release number in RELEASE. 1998-08-04 16:59:29 +00:00
Guido van Rossum 5fdd119aba Clarify the + and b mode characters for open() a bit. 1998-07-29 21:05:35 +00:00
Fred Drake b35631587b Pass paper size to dvips explicitly. 1998-07-29 05:07:41 +00:00
Fred Drake 8f7abed9d4 Update. 1998-07-29 04:45:53 +00:00
Fred Drake d05177fa84 tohtml(): Use a table instead of a definition list for module synopses. 1998-07-29 04:45:23 +00:00
Fred Drake d19b9d6c07 Fix two remaining references to all-pdf and all-ps to only use pdf and ps. 1998-07-29 03:49:44 +00:00
Fred Drake 9f86b662d1 Update to use a separate page for front matter. 1998-07-28 21:55:19 +00:00
Fred Drake e574405eff Update the HOWTO template to use a separate page for front matter, with
comments.
1998-07-28 21:53:34 +00:00
Fred Drake 514cd87d40 do_cmd_maketitle(): No <hr> at the end of the "title page". 1998-07-28 21:52:57 +00:00
Fred Drake 1e4973be73 Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi
stuff.  \ifhtml ...\fi for HTML only.
1998-07-28 21:52:17 +00:00
Fred Drake efc17bd968 Added ref/ref.tex to REFFILES.
Fixed up some comments.

Removed info-related targets from the really big combined targets.
1998-07-28 21:05:16 +00:00
Fred Drake 61c7728cc9 Make sure all chapters, sections, and subsections have a \label to give them
semantic file names in the HTML.  No more node#.html files!
1998-07-28 19:34:22 +00:00
Fred Drake 020f8c0139 Make sure chapters, sections, and subsections all have a \label to give them
semantic file names in the HTML version; no more node#.html files.

Fix one section heading.
1998-07-28 19:32:59 +00:00
Fred Drake ee7fd697bf Fixed the gzip synopsis. 1998-07-27 22:30:15 +00:00
Fred Drake a30e469fda Added the popen2 synopsis. 1998-07-27 22:20:02 +00:00
Fred Drake 54327c4c05 Added the calendar synopsis. 1998-07-27 22:18:24 +00:00
Fred Drake edf6b1f431 Added the bisect synopsis. 1998-07-27 22:16:46 +00:00
Fred Drake 9030b0f053 Added the dumbdbm synopsis. 1998-07-27 22:12:26 +00:00
Fred Drake 08caa964c4 Added a synopsis. 1998-07-27 22:08:49 +00:00
Fred Drake 9643c6706f Fix the synopsis.
Change one \code{} to \samp{}.
1998-07-27 22:06:12 +00:00
Fred Drake b44e75339a Mark the new & changed items. 1998-07-27 21:11:42 +00:00
Fred Drake 6481ba6251 Update the release date. 1998-07-27 21:10:54 +00:00
Fred Drake 53af049499 do_cmd_localmoduletable(): Cause the child links table to be dropped when
there's a local module list.
1998-07-27 20:48:26 +00:00
Fred Drake 897d12bb87 do_cmd_versionadded(),
do_cmd_versionchanged():  Support for new macros.
1998-07-27 20:33:17 +00:00
Fred Drake af958c7be2 \versionadded,
\versionchanged:  New macros.
1998-07-27 20:32:33 +00:00
Fred Drake 9ad9c9be03 Convert operator precedence table to the new style markup.
Added lambda to the table.
Call "**" exponentiation instead of power.

{\em ...} --> \emph{...}
1998-07-27 20:27:53 +00:00
Fred Drake 6f5bf8d59a Minor tidy. 1998-07-27 19:12:58 +00:00
Fred Drake f7685d79e2 Fix up the synopsis table stuff so it gets things right at each chapter,
instead of stringing it all together.

Yay!
1998-07-25 03:31:46 +00:00
Fred Drake b3a3ed8f72 Update @INC so we can 'require' modules in Doc/perl/.
Call the localmoduletable handling once the document is complete & synopses
have been collected.
1998-07-24 22:17:34 +00:00
Fred Drake a0f4c94af6 Added module synopsis support with one (big) caveat: All the modules are
listed in each chapter that has a \localmoduletable.  This will be fixed,
and everything else seems to be working fine.
1998-07-24 22:16:04 +00:00
Fred Drake 2903d03e2d tohtml(): Make module names anchors. 1998-07-24 22:13:37 +00:00
Fred Drake a1cce714d0 Converted some {tabular}s to use {tablei*} environments. 1998-07-24 22:12:32 +00:00
Fred Drake 30e52653e1 {tableiv} environment: Four-column table.
\lineiv:  Row for {tableiv}.
1998-07-24 22:11:29 +00:00
Guido van Rossum aca61a43dd Removing all references to FrameMaker 1998-07-24 20:58:52 +00:00
Guido van Rossum 6a2fe26861 checkpoint before I throw this away 1998-07-24 20:55:06 +00:00
Guido van Rossum 579c8453c3 Checking in uninteresting changes (mostly window resizes :-)
before I remove all this cruft.
1998-07-24 20:54:00 +00:00
Guido van Rossum 2babd7b151 Document getsize(), getmtime(), getatime(). 1998-07-24 20:49:39 +00:00
Guido van Rossum 89a79d19b7 Document makedirs(), removedirs(), renames() -- ESR-inspired super-versions
of mkdir(), rmdir() and rename() that make or remove intermediate
directories as well.
1998-07-24 20:48:20 +00:00
Fred Drake 7313b03469 My first Perl object. ;-)
SynopsisTable objects are used to store the table of module synopses for
a single chapter it the manual.
1998-07-24 20:34:59 +00:00
Fred Drake 246837d0f5 Fix markup of an \indexiii --> only two parameters were given. 1998-07-24 20:28:22 +00:00
Guido van Rossum d540509682 Changes copied from the FrameMaker version. Hardly anything (but then
this is the shortest chapter.)

Hurray, I'm done with this!
1998-07-24 18:56:17 +00:00
Guido van Rossum 5399d68c4b Changes copied from the FrameMaker version. Not too much. 1998-07-24 18:51:11 +00:00
Guido van Rossum 56c2013d15 Changes copied from the FrameMaker version. Also documented some
previously undocumented features.

Packages and the import mechanism in general are still left
undocumented.
1998-07-24 18:25:38 +00:00
Fred Drake 34116ba933 Remove all-<format> targets in favor of just <format>.
Fix some comments.

For lib.pdf, run tools/toc2bkm.py to get "bookmarks" in acroread.
1998-07-24 15:42:12 +00:00
Guido van Rossum 7c0240f112 e.g. -> e.g., 1998-07-24 15:36:43 +00:00
Fred Drake c2aa9fbad9 Remove use of the avant package; Helvetica isn't as pretty, but works for
acroread.  The problem this solves is likely dependent on font availability,
so keeping things simple is a good solution.
1998-07-24 15:19:38 +00:00
Guido van Rossum b193c95165 Document Ellipsis (not much of a documentation snippet, but at least
it's mentioned.
1998-07-24 15:02:02 +00:00
Guido van Rossum 1eb200d360 Added 3 missing types: ComplexType, SliceType, EllipsisType. 1998-07-24 15:01:05 +00:00
Fred Drake 78a6ddbdd1 Move files around in a different way, so CVS picks up all the changes. ;-) 1998-07-24 14:27:22 +00:00
Fred Drake 3f8a59f146 Reflect file renamings for the Python Library Reference.
Fix style dependencies for HOWTO documents.
1998-07-24 13:58:27 +00:00
Fred Drake 64e3b43583 Move files around to get the names to match the module names except for
case.  Two modules (SocketServer, BaseHTTPServer) still don't match; those
names are just too long!
1998-07-24 13:56:11 +00:00
Fred Drake 889f53d4e0 Reduce the number of levels in the Table of Contents by one, mostly for the
Python Library Reference.  The other manuals do not suffer.

This does not affect HOWTO documents.
1998-07-24 13:54:29 +00:00
Fred Drake 13529c41e4 Remove item about one section === one module; done.
Add item about howto docs that use \localmoduletable problem for howto
documents.
1998-07-24 13:02:17 +00:00
Guido van Rossum 3a0ad6089b Changes copied from the FrameMaker version, and some new stuff
(complex numbers, power operator).
1998-07-23 21:57:42 +00:00
Fred Drake 5420f3321d \textunderscore: Re-define with a width that's more appropriate for the
courier font used in Python code.  This still isn't *good*, but
	makes the width about right in most cases.  (Exception: it's now
	a little wide in \var words.)
1998-07-23 21:41:02 +00:00
Fred Drake cf0fb8bfee Document the 'p' format character.
Clean up some of the markup.
1998-07-23 21:18:25 +00:00
Fred Drake c457ca7ede Fix up Barry's markup, which didn't pass the latex test. ;-) 1998-07-23 20:31:53 +00:00
Barry Warsaw da00c878bd Added descriptions of EnvironmentError and OSError; updated IOError to
reflect its new place in the exception hierarchy; fixed typos, etc.
1998-07-23 19:57:35 +00:00
Barry Warsaw eef2cd14c9 Updated the description of os.error to reflect the fact that it is now
equivalent to exceptions.OSError.
1998-07-23 19:50:09 +00:00
Fred Drake 27467e4b7e Logical markup. 1998-07-23 19:47:41 +00:00
Guido van Rossum b18a93b4c8 Changes copied from the FrameMaker version (hardly anything original). 1998-07-23 19:36:00 +00:00
Fred Drake 3bd9ab0ef3 Use the new module synopsis syntax, even though we don't need a synopsis table
for this chapter.  This protects against backend changes for \declaremodule.
1998-07-23 19:33:08 +00:00
Fred Drake 8cab549c0a use_latex(): Hack to pass .syn files though uniq, so that the last module
in a HOWTO document isn't listed in the synopsis table twice.  This
	will do until the real bug is found (low priority!).
1998-07-23 19:13:52 +00:00
Fred Drake 465a42a58e Added targets dvi, pdf, and ps, to make all of the documents in those formats. 1998-07-23 18:10:51 +00:00
Fred Drake b91e934cf1 Adjusted to use the new module synopsis support macros. 1998-07-23 17:59:49 +00:00
Fred Drake fe7f3bc2aa Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
macros.
1998-07-23 17:55:31 +00:00
Guido van Rossum dfb658c386 'name space' -> 'namespace' 1998-07-23 17:54:36 +00:00
Fred Drake a488f30627 Lots of new stuff for "module synopsis support." Public interface consists
of three macros, one which replaces some of the current conventions used in
the module sections:

  \declaremodule:  Requires two parameters: module type (standard, builtin,
	extension), and the module name.  An optional parameter should be
	given as the basis for the module's "key" used for linking to or
	referencing the section.  The "key" should only be given if the
	module's name contains underscores, and should be the name with the
	underscore's stripped.  This should be the first thing after the
	\section used to introduce the module.

  \modulesynopsis:  Requires a single parameter: a short, one-liner
	description of the module that can be used as part of the chapter
	introduction.  This should probably be placed just after the
	\declaremodule, but may be placed anywhere in the same section.

  \localmoduletable:  No parameters.  If a .syn file exists for the current
	chapter (or for the entire document in howto docs), a synopsistable
	is created with the contents loaded from the .syn file.

Some re-organization due to module synopsis support.

Some \def's changed to \newcommand's.
1998-07-23 17:50:45 +00:00
Fred Drake 2fcadb2ffb \py@ModSynopsisFilename: New macro; gives names of the .syn file. 1998-07-23 17:36:46 +00:00
Fred Drake 1cc6d53f65 \py@ModSynopsisFilename: New macro; gives names of the "current" .syn file.
\chapter:  Extended, ensures that a pending module synopsis is written out
	and then closes the .syn file for the preceeding chapter.
1998-07-23 17:36:14 +00:00
Fred Drake c31cc38106 Ignore the new ".syn" files used to handle module synopses. 1998-07-23 17:33:10 +00:00
Guido van Rossum 83b2f8ad3d Lots of changes copied from the FrameMaker version. Also documented
some previously undocumented features.
1998-07-23 17:12:46 +00:00
Guido van Rossum be260101cb # Oops, correct Latex errors. 1998-07-22 21:51:41 +00:00
Guido van Rossum 0af2f63056 Document how to make a POST request with urlopen().
Change the argument name for quote() and quote_plus() to safe (which
matches the implementation).

Add doc for the *new* function urlencode().
1998-07-22 21:34:21 +00:00
Guido van Rossum 897b9f0b0d Add new syntax for specifying filenames on break and clear commands. 1998-07-20 23:29:10 +00:00
Guido van Rossum d623d20e7d Complete the addition of libthreading.tex. (Isn't it annoying that
you need to edit four files in order to add one section to the manual?)
1998-07-20 17:34:50 +00:00
Fred Drake a9f445cd8d Add libthreading.tex to LIBFILES. 1998-07-20 14:01:20 +00:00
Andrew M. Kuchling 16440e63be Added libthreading.tex ; this is mostly the contents of threading_api.py,
with LaTeX markup added, and some small rewrites to improve the prose.
1998-07-20 13:46:10 +00:00
Guido van Rossum dfba2fbfd0 Eric Raymond documents two already-existing functions (bmp, png). 1998-07-17 19:01:29 +00:00
Fred Drake f029548ac2 Added item about index item/subitem separation. 1998-07-08 21:42:41 +00:00
Fred Drake 5da5a68325 Fix suggested by Lorenzo M. Catucci <lorenzo@argon.roma2.infn.it> to keep the
large letter at the top of each index section with at least the first entry
for that letter.
1998-07-08 21:37:25 +00:00
Guido van Rossum a4289a79f8 In the example iterating over sys.argv and opening each argument,
change it to iterate over sys.argv[1:].  Suggestion by Gerry Wiener.
1998-07-07 20:18:06 +00:00
Guido van Rossum 7bda89f694 Rewritten a bit to address some criticism in the newsgroup. 1998-07-06 20:47:40 +00:00
Guido van Rossum 5f574aace9 Added back the description of the exec statement. It appears that I
accidentally cut it out when removing the access statement!  Added a
paragraph on __builtins__ and other possible manipulations of the key
space of the dictionaries.  Added some index entries.
1998-07-06 13:18:39 +00:00
Fred Drake 1717ba498f Normalize markup. 1998-07-02 19:36:50 +00:00
Fred Drake 579d366458 Normalize the markup. 1998-07-02 19:35:12 +00:00
Fred Drake 3f6034dcce Added index entry. 1998-07-02 19:33:43 +00:00
Fred Drake 91e5211bbf Added \deprecated to exit_thread() function.
Reflects Guido's revision.
1998-07-02 19:33:12 +00:00
Fred Drake 8e54abe92e Fix the \kbd definition so it didn't leave the courier face on. 1998-07-01 14:49:25 +00:00
Fred Drake 3240dd2bc2 Mark the actual SMTP commands (HELO, etc.) the same way FTP & NNTP commands
are in the appropriate sections.

Some minor nits.
1998-07-01 14:10:52 +00:00
Andrew M. Kuchling 108943c216 Added a section to the chapter on modules, describing the package system.
The text is almost completely from GvR's essay on packages; some
introductory paragraphs have been removed, and everything after the
'Details' section in the HTML has been dropped (seems too technical).  A
paragraph has been added after the sample package layout stating that there
must be a file called__init__.py in a directory to make it a package.
1998-07-01 13:58:55 +00:00
Guido van Rossum cf51dacfb8 Document __copy__() and __deepcopy__() methods. 1998-06-30 16:54:33 +00:00
Fred Drake 5b68362a3a Use the real name of the module: "smtplib", not "smtp".
Use logical (& consistent) markup.

Added a see-also section at the end.
1998-06-30 16:53:52 +00:00
Guido van Rossum 8ec619f60e Note that readline returns '' on EOF, not "EOF" (whatever that may be). 1998-06-30 16:35:25 +00:00
Guido van Rossum 472b9a3f06 Clearly I was to quick with the previous commit...
Need to add \optional{} to sort argument too.

Made x a \var in descr of pop.

Fixed note for pop() and mentioned that it is experimental.

Also added pop to index.
1998-06-30 16:02:35 +00:00
Guido van Rossum 97ea116472 Documented the pop() method for lists.
# The brackets generated by \optional{} are real ugly.  Alas...
1998-06-30 15:56:23 +00:00
Guido van Rossum 9c59ce9b5a Documented os.linesep (line separator). 1998-06-30 15:54:27 +00:00
Guido van Rossum cd90509d58 As suggested by pson@pson.pp.se, correct the docs for head(), body(),
article().
1998-06-30 14:53:41 +00:00
Andrew M. Kuchling 52a79e8e1c Changed URL to crypto page. 1998-06-30 13:42:05 +00:00
Guido van Rossum 6c373f758f Document new default arg to groups() and new functions/methods
groupdict() and findall().
1998-06-29 22:48:01 +00:00
Guido van Rossum 002f7aae08 Note that no .pyc/.pyo files are created for script files. 1998-06-28 19:16:38 +00:00
Guido van Rossum f9cfb173cd Now cmd is documented too. 1998-06-28 18:01:59 +00:00
Guido van Rossum a40d643cdc Documented smtplib, multifile 1998-06-28 17:58:06 +00:00
Guido van Rossum 8ddbe9119f Documented cmd, smtplib, multifile 1998-06-28 17:57:27 +00:00
Guido van Rossum f78a52c1ae Added cmd, smtplib, multifile 1998-06-28 17:57:05 +00:00
Guido van Rossum 8668e8e49c Contributions by Eric Raymond: documentation for modules
cmd, multifile and smtplib.
1998-06-28 17:55:53 +00:00
Guido van Rossum 73d8bff44d Document optional kwargs argument to start_new_thread(). Also
document new LockType and reverse the preference for exit()
vs. exit_thread() -- exit() is now preferred and exit_thread() is
obsolete.
1998-06-27 18:25:44 +00:00
Fred Drake e5836d9811 Mark the 'whence' parameter of the file object's seek() method as optional;
it's already decribed that way in the description.
1998-06-25 16:26:56 +00:00
Fred Drake 2d4a54da32 Removed loading of shared font stuff from howto.cls and manual.cls, moving it
to pypaper.sty.

Added the use of the "avant" package to use AvantGarde for the sans-serif
font instead of the helvetica font loaded by the "times" package.
1998-06-22 17:50:34 +00:00
Fred Drake 44c413b05e Make the large letter at the top of each section use the sans-serif font,
like any other header.
1998-06-22 17:27:48 +00:00
Fred Drake 8e7c82648f Added texinputs/pypaper.sty to the list of manual style files, so that the
.dvi files are properly dependent on it.
1998-06-22 17:14:47 +00:00
Andrew M. Kuchling 65b7863efc Fix unclear wording pointed out by Tim Peters, about the interaction between
^ and the pos argument to re.match().
Also, fixed a typo in libregex.tex.
1998-06-22 15:02:42 +00:00
Guido van Rossum a8a1b9bc65 There's no point in mentioning F6 as an alternate EOF on DOS -- it
doesn't work on modern Windows systems, and Control-Z works
everywhere.
1998-06-22 14:28:39 +00:00
Guido van Rossum a7874d1505 Revert the change of revision 1.30. While it's in general a laudable
goal to use isinstance(x, y) instead of comparing type(x) to y, it
doesn't make sense to change this in the example code for the type()
builtin...
1998-06-22 14:07:36 +00:00
Fred Drake 1b0ff2c32f eval() example: Removed final interpreter prompt; other examples don't have
the empty prompt.
1998-06-19 21:19:50 +00:00
Fred Drake 59160706b3 Somewhat updated, but not checked for everything (just the stuff I was using). 1998-06-19 21:18:28 +00:00
Guido van Rossum 7b7f6688d2 Added a stronger warning about changing the dictionary returned by
locals().
1998-06-18 16:45:34 +00:00
Guido van Rossum faac0136f4 # Untabified the example :-( 1998-06-17 22:38:09 +00:00
Guido van Rossum bca1207ac8 Documented that by default the output goes to stderr, and that a file
keyword argument can be used to direct it somewhere else.  Also
documented all the other functions in this module, and even added a
little example.

# Haven't tested the latex for correctness -- all latex installations
# appear broken.
1998-06-17 22:37:26 +00:00
Guido van Rossum 777dcc6b21 Change the description of input() -- it is exactly equivalent to
eval(raw_input(s)).  The statement about breaking a long expression
over multiple lines is no longer true.
1998-06-17 15:16:40 +00:00
Guido van Rossum 872948350f Some extra notes, and describe a new class (AddressList), all by ESR. 1998-06-16 22:27:40 +00:00
Guido van Rossum 60f2f0cf8e Lots of changes to get this in sync with the Frame version.
Added raw strings, imaginary literals, assert and exec (!) keywords, a
table about Resererved classes of identifiers, and more.
1998-06-15 18:00:50 +00:00
Guido van Rossum 0bd3795d6a Two small additions to make it identical to the obsolete Frame version. 1998-06-15 16:27:37 +00:00
Guido van Rossum dc1dab18a5 NewNew abstract, copied from the obsolete Frame version. 1998-06-15 16:27:09 +00:00
Guido van Rossum a3eebe60dc Add warning about use of lowercase/uppercase with maketrans(). 1998-06-11 16:03:30 +00:00
Guido van Rossum 444d0f87c9 Eric Raymond: added doc for isheader(); improved docs for constructor. 1998-06-11 13:50:02 +00:00
Guido van Rossum 1299100324 Document the changes I just checked in. 1998-06-10 21:34:27 +00:00
Guido van Rossum 3e5fe422cc Document several variables that were previously undocumented,
including the new __stdin__, __stdout__ and __stderr__.
Also moved setttrace around to its proper place in the alphabet.
1998-06-10 17:57:44 +00:00
Guido van Rossum 929bd0e02e Added notes about epochs, the year 2038, and a small Y2K disclaimer
(all with index entries!).  Also update the list of functions that
take or yield a time represented as a 9-tuple.
1998-06-09 21:25:41 +00:00
Guido van Rossum 5d23758be7 Added docs for strptime(). 1998-06-09 16:30:56 +00:00
Guido van Rossum 52481484e6 Clarify the type of the signal handler. 1998-06-09 15:42:25 +00:00
Guido van Rossum 13c8ef62e6 Say a bit more about .pyc and .pyo files. 1998-05-29 19:12:23 +00:00
Guido van Rossum a58e9edbef Document missing functions: xor, not, truth, countOf, indexOf, and
(new!) contains.
1998-05-22 18:48:37 +00:00
Fred Drake 6a50ba82ce Minor grammatical correction: "This module perform ..." --> "This module
performs ...".
1998-05-22 18:19:19 +00:00
Fred Drake 885215c3da Added support for AMK's {definitions} environment; thanks for the reminder! 1998-05-20 21:32:09 +00:00
Fred Drake 3bf7865a20 Added {definitions} environment, which has \term to define indivual terms.
Similar to {description}.
1998-05-20 17:42:17 +00:00
Fred Drake e194beb829 Don't use a separate node for footnotes; see if people scream. ;-) 1998-05-19 19:38:49 +00:00
Fred Drake e87ab1fbf2 Fix definition of release_version (global). 1998-05-19 19:37:55 +00:00
Fred Drake 7c68ab2f2b Added entry for mimetypes. 1998-05-19 19:13:01 +00:00
Fred Drake 806a1bf34f webcheck target in this Makefile wasn't used. 1998-05-19 18:04:44 +00:00
Fred Drake 79c0f0efc4 Fix the webcheck target so it checks the right files.... 1998-05-19 18:04:13 +00:00
Fred Drake edde150127 Add mimetypes documentation to library reference dependencies. 1998-05-19 15:04:21 +00:00
Fred Drake b818b46b38 Add section documenting mimetypes module. 1998-05-19 15:03:45 +00:00
Guido van Rossum c85be6a0ff Fix another oldie (item (b) only):
Date:    Fri, 20 Dec 1996 14:47:50 +0100
From:    Lele Gaifax <lele@nautilus.eclipse.it>
To:      Python List <python-list@cwi.nl>
Subject: Typos in ref manual

Hi all,
browsing the reference manual I noticed what seem two small errors:
  a) in the list of keywords (section 2.3.1) 'exec' is missing
  b) in the Operator Precedence table (5.12) the comparison operators
     include '=', but probably '==' was intended.
Hope this help,
lele.
1998-05-16 02:11:10 +00:00
Fred Drake e593b6213a Small change to the l2h target allowing the output dir, $(HTMLDIR), to be
a sibling of the html/ directory in the distribution.
1998-05-15 17:50:32 +00:00
Fred Drake a4565b0796 Update to use latex2html 98.1p5. 1998-05-15 17:14:17 +00:00
Fred Drake 8dbf46a79e Update to use latex2html 98.1p5.
Cleanup temporary files produced by latex2html in the output directory.
1998-05-15 17:13:08 +00:00
Fred Drake e0a0fcd552 Update note about latex2html version required. 1998-05-15 17:03:00 +00:00
Fred Drake cdbd391415 Add support for the Macintosh Library Modules document. 1998-05-15 17:02:10 +00:00
Fred Drake 5b73cdfe60 Revise comment about \let support a little to more accurately reflect the
support that's offered.
1998-05-15 16:59:38 +00:00
Fred Drake 13b1f43851 Ignore the mac/ directory.... 1998-05-15 16:56:44 +00:00
Fred Drake d637406df1 Update to use the output names used by latex2html for the Python Reference
Manual; the old FrameMaker names no longer apply.
1998-05-15 16:18:21 +00:00
Fred Drake 7a4ad0fc83 Extend handling for \let a bit, to also allow \let\something=<character>. We
still don't support things like \let^^M=\something, where ^^M could actually be
any active character.  Print a decent warning if we find one we can't handle.
1998-05-15 13:45:54 +00:00
Fred Drake 8d1b3384c3 Remove debugging echo. 1998-05-15 13:38:21 +00:00
Fred Drake e16f6798ae do_cmd_let(): Simple implementation to allow \let to be used to establish
synonyms for macros.  This supports:

	\let\newname = \oldname
	\let\newname\oldname

This is useful sometimes, and can at least avoid real errors at other times.
1998-05-15 04:28:37 +00:00
Fred Drake d07868ae52 Added support for \developer, \developers, \developersaddress. 1998-05-14 21:00:28 +00:00
Fred Drake 6df93ef9dd Added definitions for \developer, \developers, \developersaddress.
Ask Guido if you really want to know why.  ;-)
1998-05-14 20:56:31 +00:00
Fred Drake df825a10fc Fix the fix to allow the .tex document sources not live in ".". 1998-05-14 20:36:49 +00:00
Fred Drake 25d4e2873c Mostly spurious change to ensure that everyone's version of this picks up the
execute bit.... problem discovered by Guido.
1998-05-14 20:07:10 +00:00
Fred Drake f4fc476885 Don't run tools/toc2bkm.py unless we're building PDF.
Change the way TEXINPUTS gets defined to ensure that the directory containing
the main document file comes before any other dir, to allow documents to have
files that "override" like-named files elsewhere on the search path.  Guido
discovered we needed this.
1998-05-14 20:03:14 +00:00
Fred Drake 5c07d9b028 Updated markup style (got rid of \verb@...@, mostly). 1998-05-14 19:37:06 +00:00
Fred Drake 203b4f1a25 Add an index entry.
Bow to font lock.
1998-05-14 15:16:12 +00:00
Fred Drake 1a87e9d708 Add comments about release status. 1998-05-12 16:50:32 +00:00
Fred Drake e34ab30a3f Switch to .tgz instead of .tar.gz to appease Windows users.
Clean up the clean & clobber targets.
1998-05-11 21:10:15 +00:00
Fred Drake 72dd58d90e Use .tgz instead of .tar.gz for the output file name. 1998-05-11 21:08:39 +00:00
Fred Drake d2af396dd5 Change ignored extension .tar.gz to .tgz. 1998-05-11 21:07:52 +00:00
Fred Drake 2f61cd4dcc Ignore intermediate files. 1998-05-11 21:06:18 +00:00
Fred Drake ba1700c7bb Set the right page size in the PDF output. 1998-05-11 20:42:54 +00:00
Fred Drake d5d473fd5c Add --letter option, similar to --a4. This is a no-op, but can be used from
a Makefile:  mkhowto.sh --$(PAPER).
1998-05-11 20:40:24 +00:00
Fred Drake 8981fdf16e Add the clean, clobber targets here for this directory. 1998-05-11 19:54:57 +00:00
Fred Drake a4c640e142 Reverted the last change; the extra cruft is harmless for formatted versions,
and allows the info to work through this section.
1998-05-11 19:51:11 +00:00
Fred Drake 58ff112e7f Don't be so ugly as to use "set -x" to get the executed commands printed. 1998-05-11 19:06:26 +00:00
Fred Drake 4190fae02a Added a section about documentation for the Mac modules. 1998-05-11 19:05:36 +00:00
Fred Drake 1a3541c29c Oops, better add it to the usage message! 1998-05-11 19:04:56 +00:00
Fred Drake 3504952781 Add easy-to-use support for A4 paper. 1998-05-11 19:04:06 +00:00
Fred Drake efad443351 Remove the tarhtml target; not useful from the sub-make. 1998-05-11 18:54:02 +00:00
Fred Drake 29cabd4cd7 Pass the release number to the tools/mktarball.sh script.
Nits.
1998-05-11 18:53:07 +00:00
Fred Drake f2fa1e2afe Accept the release number on the command line instead of hardcoding it. 1998-05-11 18:52:24 +00:00
Fred Drake 323dc70de5 Don't be so ugly as to use "set -x" to get the executed commands printed. 1998-05-11 18:41:16 +00:00
Fred Drake 2e7edb80e3 do_cmd_kwindex(): Re-implement now that \kwindex is used again (ref man). 1998-05-11 18:31:17 +00:00
Fred Drake d69e2c4f33 Update some of the comments.
Update the .tar.gz targets so that they work from the top level.

Reinstate the api, ext, lib, ref, and tut targets.
1998-05-11 18:25:46 +00:00
Fred Drake 41814bc51f In package Override, use the getcwd() function from the Cwd module instead of
the one from Override.pm (part of latex2html).

Absolutize the TEXINPUTS environment variable, since we can't count on
latex2html doing it for us (even though I sent in a patch, and it really
should).
1998-05-11 18:23:35 +00:00
Fred Drake 099b76c3bd Changed some comments.... no longer mention FrameMaker. 1998-05-11 16:31:32 +00:00
Fred Drake b9838d97ad Fix a comment.
Avoid extra level of recursion in the paper-*/ directories.

Added the "info" target to use the subdir.  Partparse, however, is broken
again.
1998-05-08 15:43:08 +00:00
Fred Drake 9447e592d9 No longer needed. 1998-05-08 15:41:23 +00:00
Fred Drake a5d80564af Remove unneeded line. 1998-05-08 15:40:46 +00:00
Fred Drake 02379fab61 Use \ldots, not \dots. The info process doesn't know about \dots. 1998-05-08 15:39:40 +00:00
Fred Drake 8ffa21c7aa Adjust to new file layout. 1998-05-08 15:37:13 +00:00
Fred Drake 47fd8fed7c Move the rules to build the info files here. 1998-05-08 15:36:36 +00:00
Fred Drake 230b530a6a Relocating file to Doc/info. 1998-05-08 15:35:36 +00:00
Guido van Rossum 7b0c9d8a07 exec is a statement, not a function! 1998-05-08 13:27:38 +00:00
Fred Drake 445cfd339c l2h target: Do the "right thing" regarding the paper-*/ subdirs as the other
"big" targets.  Fix is to set the TEXINPUTS on the command line of the
	sub-make.
1998-05-08 04:02:42 +00:00
Fred Drake f4166a478a Some versions of latex2html don't automatically append the .tex extension to
the name of the main .tex source file if it's not in the current directory.
1998-05-08 04:00:56 +00:00
Fred Drake df68e3dd6d $(KPSEWHICH): Use the older style of calling kpsewhich with the arg
specifying *which* type of path to search.  This works for both
	teTeX 0.4 and 0.9.  This is what we call portability these days!  ;-)
1998-05-08 03:46:38 +00:00
Fred Drake 4a9129c7e8 /bin/sed works on both Solaris and RedHat Linux; /usr/bin/sed does not. 1998-05-08 03:42:23 +00:00
Fred Drake 566d20951d Oops! Must have deleted a word by accident before the last check-in of this
file; "make" (the 'all' target) became a no-op!

Now works as previously described.
1998-05-08 02:00:48 +00:00
Fred Drake 19c7c84db8 Be a little more robust handling filenames. 1998-05-07 21:20:39 +00:00
Fred Drake 8923c72c8f Ignore the webchecker turd. 1998-05-07 20:13:21 +00:00
Fred Drake 0a96cca7ec Added the webcheck target here. 1998-05-07 20:00:59 +00:00
Fred Drake f295113f1f Cleaned out some more cruft.
Added some new cruft.

For some of the "big" targets, force things to happen in the "right"
subdirectory, i.e., "make" will build the DVI and PostScript files in the
paper-letter/ directory, and "make PAPER=a4" will build DVI and PostScript
files in the paper-a4/ directory.

Probably still needs some restructuring.
1998-05-07 19:30:16 +00:00
Fred Drake a34f7e6a5d Some cleanup, added clean & clobber targets. 1998-05-07 19:27:40 +00:00
Fred Drake bf332696a1 Add support for a --pdf option to cause a PDF file to be created instead;
most of the processing is the same and has to be done anyway.
1998-05-07 17:28:42 +00:00
Fred Drake f8e4415578 Markup consistency.
Using \input instead of \include to avoid extra .aux files from being
generated.
1998-05-07 17:27:32 +00:00
Fred Drake 47b0ecd580 Small updates. 1998-05-07 16:32:56 +00:00
Fred Drake 0ef1b079a2 Preliminary convenience Makefile. 1998-05-07 15:12:51 +00:00
Fred Drake 106fe12ebf Better go ahead and remove some cruftiness.... 1998-05-07 15:05:56 +00:00
Fred Drake 9cdf08797e Support the new directory structure.
Some targets may be a little raw, but the basic formatting targets are all
tested, primarily for use from the subdirs.  There are probably a few
gotchas, and the paper-*/ directories could use "helper" Makefiles.
1998-05-07 15:03:25 +00:00
Fred Drake 46ed208b46 Relocating file to Doc/html. 1998-05-07 15:00:46 +00:00
Fred Drake fa615bfee1 Ignore .tar.gz files in this directory. 1998-05-07 14:56:41 +00:00
Fred Drake 4383e6e24f Don't ignore the html/ directory. 1998-05-07 14:54:21 +00:00
Fred Drake 8920156d04 New script to drive HTML generation. 1998-05-07 14:53:55 +00:00
Fred Drake 4c9542b271 Ignore subdirectories if your name is "cvs". 1998-05-07 14:51:53 +00:00
Fred Drake 60515f49b8 Sub-makefile that can be used to drive the HTML conversion from this subdir.
Most of the logic is still in the primary Makefile and a new script in
Doc/tools/.
1998-05-07 14:50:22 +00:00
Fred Drake 4775d0a353 Relocating file to mac. 1998-05-07 12:58:57 +00:00
Fred Drake 0a52bdfd4f Relocating file to Doc/ext. 1998-05-07 01:50:47 +00:00
Fred Drake cda63cc875 Relocating file to Doc/lib/ 1998-05-07 01:49:07 +00:00
Fred Drake bbe33c5594 More changes to support the new directory structure. 1998-05-07 01:39:06 +00:00
Fred Drake 5360879740 New helper script to build the .dvi for a Python manual; usable for the
api, ext, ref, and tut manuals.  The Library Reference requires too much
special index processing to make it beneficial to extend this to support
it.
1998-05-07 01:38:16 +00:00
Fred Drake 8e6c6b2645 Relocating file to Doc/ref. 1998-05-07 01:36:12 +00:00
Fred Drake 64958d593c Relocating file to Doc/mac. 1998-05-06 21:54:44 +00:00
Fred Drake 2880beb3d9 Relocating file to Doc/api. 1998-05-06 21:51:05 +00:00
Fred Drake 56727e2b70 Relocating file to Doc/tut. 1998-05-06 21:49:56 +00:00
Fred Drake 99a5c087c6 Change the set of subdirectories to ignore. 1998-05-06 21:46:08 +00:00
Fred Drake ffe9b459ab Ignore intermediate files. 1998-05-06 21:43:40 +00:00
Fred Drake f24b3a3c7c Ignore temporary files. 1998-05-06 21:43:11 +00:00
Fred Drake 0d162d0eb6 Modified version of ../texinputs/pypaper.sty that specifies A4 paper. 1998-05-06 21:40:50 +00:00
Fred Drake dde91f000a Fix a bogus \code@...@ to be \code{...}.
Normalize some other markup.
1998-05-06 20:59:46 +00:00
Fred Drake 744a662f36 Relocating file to Doc/texinputs. 1998-05-06 20:20:14 +00:00
Fred Drake f666917ab7 The Python Reference Manual. 1998-05-06 19:52:49 +00:00
Fred Drake a6bb39622c First cut at welcoming the Python Reference Manual back to the fold. 1998-05-06 19:51:39 +00:00
Fred Drake 0cabff904f \itembreak,
\itemjoin,
\kwindex:  Revived definitions to support the Python Reference Manual.
1998-05-06 19:36:01 +00:00
Fred Drake f7ffa92ce3 Fix typo in example found by Anthony Starks <anthony_starks@merck.com>,
reported to me by Piers Lauder <piers@cs.su.oz.au>.
1998-05-06 12:42:37 +00:00
Fred Drake c9b8a57040 cleanup(): Remove *all* the temp files related to index generation! 1998-04-29 21:28:25 +00:00
Fred Drake 91eeefdee4 Work around lack of support for \if... in latex2html. 1998-04-29 17:56:44 +00:00
Fred Drake 89a1d4ad3a Set $TEXINPUTS='' to make l2h pick up the right thing from the environment. 1998-04-29 16:58:13 +00:00
Fred Drake 06245ac2fa Fix documentation based on comments from Sean Reifschneider
<jafo-9804@tummy.com>.

Logical markup.
1998-04-29 14:38:34 +00:00
Fred Drake 9fab3aa52e Move a bit closer to HTML generation without depending on the temp files
being in the current directory.

Be more careful cleaning up.

Correct an error in a comment.

Add recent additions to the dependencies for lib.dvi.
1998-04-28 19:20:43 +00:00
Fred Drake 310094ccce do_cmd_sectcode(): Obsolete; removed. 1998-04-28 18:38:40 +00:00
Fred Drake b5aa3de118 Remove extra cruft for texi processing. 1998-04-28 18:37:12 +00:00
Fred Drake 2a3ab4fac1 Do better hiding of internal names. 1998-04-28 18:31:50 +00:00
Fred Drake 08c5dfc5a4 do_cmd_key(): Obsolete; removed. 1998-04-28 18:31:17 +00:00
Fred Drake 24340ea583 Fixed \code so word wrapping is allowed.
Removed some old stuff.

Do better hiding of internal names.
1998-04-28 18:30:34 +00:00
Fred Drake ca6b4fe36b Section for bisect module. 1998-04-28 18:28:21 +00:00
Fred Drake 188a8471b8 Moved popen2 entry to make more sense.
Added bisect entry.
1998-04-28 18:27:53 +00:00
Fred Drake 125024a87d Updated. 1998-04-28 18:27:22 +00:00
Guido van Rossum 2aefe8d7c0 Document changed semantics -- open() now guesses the db type and error
is now a tuple of various and sundry exceptions.
1998-04-28 15:29:26 +00:00
Fred Drake f8d50bfdb0 Hook in the calendar and popen2 sections. 1998-04-28 14:29:27 +00:00
Fred Drake 1c127e74af calendar module section for the library reference, by Drew Csillag. 1998-04-28 14:28:57 +00:00
Fred Drake 6afad3792d popen2 section for the library reference, contributed by Drew Csillag, with
some reorganization.
1998-04-28 14:28:15 +00:00
Fred Drake 2a1cc3e171 Use of \key and \kbd were isolated to one instance each in this file;
normalize to \kbd to allow removal of \key from the document class.
1998-04-28 13:38:54 +00:00
Fred Drake 4f31694d37 Document transfercmd(), ntransfercmd(), delete(), rmd(), size().
Thanks to Timothy Wild <twild@clear.net.nz> for catching the omission of
delete().
1998-04-27 14:54:06 +00:00
Fred Drake 23916e78d0 clean target: Remove intermediate files from creation of outline in PDF. 1998-04-25 04:15:56 +00:00
Fred Drake 724473fbe5 Load the options from the pypaper.sty file before setting up the "base class"
for the manual documents.
1998-04-25 04:12:17 +00:00
Fred Drake b4929a794e Paper size / font size configuration file.
This is separated so I can build A4 and US Letter sizes without having to
edit files.

Anyone who downloads the source package can also simply edit this file,
which is a lot shorter than the manual.cls file, and easier to find the
appropriate line.
1998-04-25 04:11:27 +00:00
Fred Drake 8805354bbc Simplify how some options get propogated. 1998-04-24 21:57:12 +00:00
Fred Drake 3af9f2514f Added libpoplib.tex to dependencies for the library reference.
Some mods to allow PS to be generated when the current dir is *not* Doc;
to help out with generating A4 versions.
1998-04-24 21:07:22 +00:00
Fred Drake a468404dda Added a section for the poplib module, contributed by Drew Csillag. 1998-04-24 20:49:02 +00:00
Fred Drake e28fb67c2c Add entry for poplib. 1998-04-24 20:08:28 +00:00
Guido van Rossum a937d14898 Fred's right -- we need PyList_SET_ITEM(). 1998-04-24 18:22:02 +00:00
Barry Warsaw dc1c970b0f This script appears to no longer be in the toolchain for Python
documentation, so it has been moved to ../../Tools/scripts

Fred, please verify.
1998-04-23 22:57:16 +00:00
Fred Drake 0d27d08790 Don't override the default $ADDRESS. 1998-04-23 20:07:55 +00:00
Fred Drake d757165df9 Change the default $ADDRESS. 1998-04-23 20:06:24 +00:00
Fred Drake f8830d1de5 Convert recent additions to use new, "logical" markup.
I suppose we really do need a markup guide.  -sigh-
1998-04-23 14:06:01 +00:00
Guido van Rossum 4447513e94 Filled in some more blanks, with the help of Drew Csillag. 1998-04-21 15:30:01 +00:00
Fred Drake 255284b42a Fix problem for the Library Reference where high-numbered sections of
high-numbered chapters took too much space for the section number in the
table of contents.  This makes the section number and title not overlap.
1998-04-20 16:55:14 +00:00
Fred Drake 42de185a77 Added \label to subsections which didn't have one, since this module has
subsections listed in the documentation index sidebar.  (Why?)
1998-04-20 16:28:44 +00:00
Guido van Rossum a933f6a53d Fix vonmisesvariate() -- it now returns an angle between 0 and *two*
times pi.  Got rid of $math$ here and in one other place.
1998-04-20 14:43:44 +00:00
Fred Drake 476412a918 cleanup(): Get rid of module index turds. 1998-04-17 20:25:55 +00:00
Fred Drake daf71fca54 Ignore the mac/ directory where latex2html spits out HTML. 1998-04-17 20:08:36 +00:00
Fred Drake a2890b0986 Make the intro section explicit, so that latex2html puts it on a separate
page from the table of contents.
1998-04-17 20:07:21 +00:00
Fred Drake 7984256f4d build_ps(): Fix flags to dvips.
build_html():  Deal with node2label.pl a little better.
1998-04-17 20:06:16 +00:00
Fred Drake 5ccf330e4c next_optional_argument(): Don't include the square brackets in the return
value.

ArabictoRoman():  Acquired function from Robert Donohue
	<donahue@cfassp48.harvard.edu>; might be useful someday, and I don't
	want to figure it out again!
1998-04-17 20:04:09 +00:00
Fred Drake 4f6d6e487c Fix things. Blame Andy Eskilsson <andy.eskilsson@telelogic.se>.
But I'm not giving this or the info files out until Andy (or anyone else)
agrees to take over the maintenance of this script!  Hah!
1998-04-17 15:28:09 +00:00
Fred Drake 4f5155817b Mark TMPDIR correctly. 1998-04-17 14:51:04 +00:00
Fred Drake bdbdb80b0b Separate the Mac-related files from the library reference files. The new
variable isn't used yet.
1998-04-17 14:01:44 +00:00
Fred Drake 1d9fb63293 Remove commented-out Mac chapter. 1998-04-17 13:24:55 +00:00
Fred Drake 12f842e33e Adjust to allow both general and module indexes.
PDF output properly supports the outline.
1998-04-17 02:52:12 +00:00
Fred Drake 60961c561d Python HOWTO document that replaces the old Mac section from the reference
manual.
1998-04-17 02:47:13 +00:00
Fred Drake b51429a145 Adjust so that it works as part of a HOWTO-based manual. 1998-04-17 02:46:34 +00:00
Fred Drake d579ed8239 Shift (re-)definition of \theindex to the document classes so that it doesn't
break HOWTO documents.
1998-04-17 02:45:41 +00:00
Fred Drake 300775d222 Hide \varvars from "public" interface. 1998-04-17 02:17:00 +00:00
Fred Drake 08932054e9 New helper functions to help deal with parameter parsing.
Use the helpers in do_cmd_*() and do_env_*(); *much* cleaner!
1998-04-17 02:15:42 +00:00
Fred Drake 64bdc24301 Code cleanup, some syntax modernization. 1998-04-17 02:14:12 +00:00
Fred Drake 6b303b4bdd Signature for dir() omitted the optional argument. 1998-04-16 22:10:27 +00:00
Fred Drake bf88c3830e Fix the broken PDF links, really this time!
Appending a junk char to the end doesn't quite do it, or doesn't seem to at
any rate.  Instead, pad the page numbers to always be 3 charaters wide, with
leading zeros.
1998-04-15 17:50:22 +00:00
Fred Drake a2c2a836d7 Fix the broken PDF links, really this time!
"." cannot be part of the target names either.

Appending a junk char to the end doesn't quite do it, or doesn't seem to at
any rate.  Instead, pad the page numbers to always be 3 charaters wide, with
leading zeros.
1998-04-15 17:50:01 +00:00
Fred Drake a88d681255 Change the form of the name given to each page of the PDF from "page.%d" to
"page.%dx"; this works around an acroread bug that causes targets not to be
recognized if their name is a prefix of another target in the file.
1998-04-15 14:53:28 +00:00
Fred Drake d671e8fb87 Added dependency on the tools/toc2bkm.py script for the PDF files. 1998-04-15 14:50:56 +00:00
Guido van Rossum 3c4378bd9b Some patches by Drew Csillag; plus a few of my own uncommitted changes. 1998-04-14 20:21:10 +00:00
Fred Drake 12d9fc94f4 Use shorter labels; using long labels creates problems on the Macintosh.
(Thanks, Just!)
1998-04-14 17:19:54 +00:00
Fred Drake 95638f5b0f Added entry for Tkdnd.py. 1998-04-14 04:55:43 +00:00
Fred Drake e3ae5198a3 Update to use the new release number. Will generalize in the next round. 1998-04-13 21:55:56 +00:00
Fred Drake f5013f1f0c Add RELEASE make variable; this gets the entire release # ("1.5.1"). 1998-04-13 21:02:49 +00:00
Fred Drake 68fede768a Added item in Misc. for getpass module. 1998-04-13 20:31:31 +00:00
Fred Drake 4d2996d473 Fix version number. 1998-04-13 20:29:45 +00:00
Fred Drake 916d8f8733 No more threats, just list the new methods under "AST Objects". 1998-04-13 18:46:16 +00:00
Fred Drake c4f1ca1967 Add a note that pickling is supported. 1998-04-13 16:27:27 +00:00
Fred Drake 3e7a48e0d9 Revert markup around list of display fields from the disassembler; it doesn't
look at good in print, but doesn't break the HTML.
1998-04-13 16:15:02 +00:00
Fred Drake 3ad125e611 Fix bug in little-used markup: don't forget to pass the source text along! 1998-04-13 14:18:57 +00:00
Fred Drake 7238988657 Fixed example to load the startup file from a script (didn't test for the
file's existance).

Removed some XXX comments about extension modules which support pickling.

Added text from AMK about the readline and rlcompleter modules.

Thanks, AMK!
1998-04-13 01:31:10 +00:00
Fred Drake 003d8da779 Typo: (and often severly limited) -- severely
Typo: (but not to the tuple or list into which the item it put!) -- is put

Thanks, AMK!
1998-04-13 00:53:42 +00:00
Fred Drake b85fbec83b "ZeroDevisionError" --> "ZeroDivisionError"
Thanks, AMK!
1998-04-13 00:50:04 +00:00
Fred Drake a608febd5f Fix typo. (What I get for trying to fix bugs at home and running conversions
at work....)
1998-04-12 03:58:13 +00:00
Fred Drake ae9bc67e0e Don't append () to the name of an object attribute in the index. 1998-04-12 03:49:46 +00:00
Fred Drake 6250205166 Use {methoddesc} instead of {funcdesc} for object methods. 1998-04-12 03:31:31 +00:00
Fred Drake 898601bf8f Add cPickle to the list of modules in the chapter. 1998-04-12 03:08:41 +00:00
Fred Drake d6d88ffaf9 Add cStringIO to the list of modules in the chapter. 1998-04-12 03:07:35 +00:00
Fred Drake c303e67f3c The built-in exceptions are not still strings, so make no claims about them. 1998-04-12 02:48:47 +00:00
Fred Drake c94d9348ca In descriptions of Py_GetPrefix() and Py_GetExecPrefix(), make sure the
"--" at the start of the configure options isn't collapsed to "-" when the
HTML is generated.
1998-04-12 02:39:13 +00:00
Fred Drake 1072e46263 Added a simpler, working {verbatim} support that generates legitimate HTML.
(2 lines, explained by 6 lines of comments....)
1998-04-12 02:16:34 +00:00
Fred Drake b73bc31e39 Removed partially broken {verbatim} support. 1998-04-12 02:13:14 +00:00
Fred Drake ee60191d1d Lighten up tables. 1998-04-11 20:53:03 +00:00
Fred Drake 17e564042d Change order of \seemodule macros at end of pickle module section. 1998-04-11 20:43:51 +00:00
Fred Drake 9463de2092 Document cPickle and cStringIO. 1998-04-11 20:05:43 +00:00
Fred Drake fab2f34538 When the text of a table cell should be wrapped, used a "p" column. 1998-04-11 18:46:56 +00:00
Fred Drake 7e9383ab59 Add a comment to indicate the methods of the StringIO are being discussed... 1998-04-11 18:05:24 +00:00
Fred Drake 70c460c84d Remove imaplib from the undocumented list. 1998-04-11 16:58:26 +00:00
Fred Drake a38a2867d0 Include () after function name.
One more logical mark.
1998-04-11 16:57:05 +00:00
Fred Drake 0d213d3497 When the text of a table cell should be wrapped, used a "p" column. 1998-04-11 16:40:46 +00:00
Fred Drake 2b8c95e4ed Minor housing cleaning in HTML that gets generated. 1998-04-11 16:26:02 +00:00
Fred Drake 34672dbb38 Remove over-active replace-string turds. 1998-04-11 16:24:21 +00:00
Fred Drake 8f6b958fdb Use {memberdesc} to mark the instance attributes. 1998-04-11 15:11:55 +00:00
Fred Drake 7dba8e2ab4 Hmmm... better add some \label macros for logical addressing while I'm at it. 1998-04-11 13:51:05 +00:00
Fred Drake 2a37455967 It's "Lauder", not "Lauders"! 1998-04-11 13:48:26 +00:00
Fred Drake 9d4b6c52c3 Update the module index support to use the changed field separator for the
input file to buildindex.py.
1998-04-11 05:21:14 +00:00
Fred Drake e5cf53ad89 Formatting nits.
An index entry.
1998-04-11 05:02:45 +00:00
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