Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
9,428 Commits 7 Branches 587 Tags 2.3 GiB
Commit Graph

1854 Commits

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