Commit Graph

2015 Commits

Author SHA1 Message Date
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