c41e1e5f5e
Remove the "---" to "—" conversion; this is wrong in verbatim
...
environments. Move the conversion to esis2sgml.py.
1999-05-18 17:33:01 +00:00
338da93734
SET_LINE_NO ==> SET_LINENO
...
Reported by Corran Webster <cwebster@math.tamu.edu>.
1999-05-17 20:57:07 +00:00
33378da964
Added paragraph explaininng the text/binary flavors of some methods,
...
to make it easier for people to find what they're looking for.
1999-05-17 16:35:15 +00:00
d1fb77970d
Document \e, \url.
...
Add a few more comments about mkhowto.
Based on comments from Albert <hat@se-46.wpa.wtb.tue.nl>.
1999-05-17 16:33:54 +00:00
4f52867d95
Don't \input boilerplate.tex, fill in the real stuff. 3rd party
...
documents probably aren't written by Guido. ;-)
1999-05-17 16:02:38 +00:00
87f768e20b
Attempted to clarify usage of the \declaremodule macro somewhat;
...
Michael Hudson's documentation for bytecodehacks exhibits incorrect
usage.
Added some comments about how to set up the mkhowto script for use
with documents not contained in the documentation source tree.
1999-05-17 15:22:45 +00:00
3e4c614c16
define_module(): Check the module type for validity before using.
...
This reflects the changes made in
../texinputs/python.sty.
1999-05-17 15:00:32 +00:00
66823029a4
\declaremodule: Typo.
1999-05-17 14:57:26 +00:00
5bc8d99bce
\declaremodule: Make this more robust. Only attempt to add an index
...
entry based on the module type if the type is known.
Otherwise, spit out a warning the the module type
parameter was bad and generate a "plain" index entry.
Without this, the bad module type was emitted as
text.
Problem noticed by processing Michael Hudson's docs for
bytecodehacks.
1999-05-17 14:47:10 +00:00
8ee593cb46
The conversion temporary files should not be ignored here anymore,
...
since they shouldn't be here. Only ignore the output tarballs in this
directory.
1999-05-13 18:57:28 +00:00
dbc2d08ff5
POP3.uidl(): Update description based on comments from Piers Lauder
...
<piers@cs.su.oz.au>.
1999-05-13 18:48:14 +00:00
dab44682c2
PyCObject_FromVoidPtr(): Clarify that the destr function will only be
...
called on destruction is non-NULL.
1999-05-13 18:41:14 +00:00
431f0ce547
Small nits around some of the index entries.
...
When refering to chapters, use \ref, don't hardcode the chapter
number.
1999-05-13 18:38:11 +00:00
ab03215204
make_index_entry(): Remove. Not only did this override the
...
l2hinit.perl version of the function (which
overrode a version in latex2html), but
do_cmd_index() was overridden. Since
do_cmd_index() was the only caller, we can trash
this.
define_indexing_macro(): New function used during setup to support
more dynamic dispatch for indexing.
process_index_macros(): New function; implement dynamic dispatching
of indexing support functions, allowing many
targets used in indexing to be shared by
multiple index entries. I.e., something like
\index{foo}\bifuncindex{bar} can now share a
single target anchor.
These indexing changes reduce the amount of clutter in the generated
HTML files. In the reference manual, this cuts the number of targets
by 44%. Targets are less affected when generated by environments
rather than macros.
1999-05-13 18:36:54 +00:00
76febdf3fd
make_index_entry(): Remove. This is overridden in python.perl and
...
was never called in this incarnation. The
other version is simpler as well.
1999-05-13 16:41:19 +00:00
7088df4c56
Removed old comments.
1999-05-13 16:20:30 +00:00
84bd6f3b18
Change the look of \seemodule output to fit in better.
1999-05-11 15:42:51 +00:00
03c05a5192
Move the "See also:" section so it appears are part of the top HTML
...
page of the section.
1999-05-11 15:15:54 +00:00
184e8360e8
Added module references; minor grammatical fixes.
...
All suggested by Eric Raymond.
1999-05-11 15:14:15 +00:00
9ade7e0110
Added missing comma, reported by Eric Raymond.
1999-05-11 13:45:37 +00:00
e779d4f03b
Lots of adjustments to deal with the document content now being stored
...
in a fragment rather than the main document object.
1999-05-10 19:36:52 +00:00
54fb7fb9d0
Some more fixes.
...
Add controls for some of the esoteric indexing macros.
1999-05-10 19:36:03 +00:00
b894370f6a
Fixed some index entries.
...
In the __coerce__ description, None should be returned if the
conversion is *impossible*, not *possible*. Reported by Robert Kern
<kernr@ncifcrf.gov>.
1999-05-10 13:43:22 +00:00
2697694e4a
ExtendedEsisBuilder.push(): Override inherited definition. We don't
...
want to push nodes into the document, but into a document
fragment, since we're not necesarily working with something
that's well-formed.
1999-05-07 21:14:28 +00:00
f79acbdaa1
Fix some bugs introduced in the previous checkin.
1999-05-07 21:12:21 +00:00
96c00b0b5e
Define & use a Conversion object. It's still really ugly, but at
...
least there's a token object in here now! ;-)
1999-05-07 19:59:02 +00:00
b0bc7f2d6c
Updated connect_ex() documentation based on comments in the newgroup
...
(M.-A. Lemburg and GvR).
1999-05-06 22:03:50 +00:00
a871c2e747
Make it work for "manual" documents as well as "howto" documents.
...
This still doesn't understand anything about multiple source files or
checking time dependencies.
1999-05-06 19:37:38 +00:00
1ea7c75687
Reflect recent patch for float % and divmod() by Tim Peters. Content
...
updates by Tim Peters, markup by FLD.
1999-05-06 14:46:35 +00:00
4437fdf265
Make sure latex2html doesn't produce a hard link between foo/foo.html
...
and foo/index.html. Make a copy instead. (Appearantly some tar
openers on non-Unixlike systems can't handle hard links.)
1999-05-03 14:29:07 +00:00
d2d1eef025
Make sure latex2html doesn't produce a hard link from $part/$part.html
...
and $part/index.html. Make a copy instead. (Appearantly some tar
openers on non-Unixlike systems can't handle hard links.)
1999-05-03 14:27:45 +00:00
ab005d5f6c
Revert constraint on the GIF wildcard; we missed a few!
1999-04-30 15:58:45 +00:00
8961bd1529
Added top navigation bar for consistency and color. There's not a lot
...
there, but the "modules" icon is active.
1999-04-29 19:54:08 +00:00
a00754468f
make_nav_panel(): Remove the spurious NAME="tex2html\d+" attributes
...
added to the anchors in the navigation bars. These
are added somewhere deep with l2h, and are stupid.
1999-04-29 19:06:56 +00:00
50c507e4b4
Added wcnew target to run the "wcnew" version of webchecker.
1999-04-29 19:04:55 +00:00
673c65e500
Use the new module-key for the FL module when hyperlinking (the old
...
one caused problems on case-insensitive file systems).
1999-04-29 18:42:18 +00:00
dbf7d99ae7
For the tutorial, use numeric node names and split by chapter.
1999-04-29 18:29:38 +00:00
c1db512b2b
Nasty hack to add a --numeric parameter to skip the use of "logical"
...
names.
1999-04-29 18:28:48 +00:00
664c72f8a1
Move index.html rules to the end since it wedges font-lock.
...
Remember to delete index.html for clobber since it is now generated..
1999-04-29 17:04:21 +00:00
d09120b5b9
Added index entries for operator precedence; suggestion from Randall
...
Hopper <rhh@vislab.epa.gov>.
1999-04-29 16:43:42 +00:00
62e80138f4
Make sure the global module index is added to the HTML tarball.
1999-04-29 15:44:49 +00:00
5cc0a9b252
Generate index.html from index.html.in. This avoids having to modify the
...
index to update the version number; boilerplate.tex remains the only document
source for this information.
1999-04-29 15:42:19 +00:00
fe1e207841
Constrain a wildcard a little more.
1999-04-29 15:32:27 +00:00
d03e9e34de
Don't point readers to rand, point to random! And make it a hyperlink
...
while you're at it.
Also, when discussing order of reading, make it clear that chapter 2
is assumed background material for the remainder of the manual.
That's needed for terminology if nothing else!
1999-04-29 13:41:17 +00:00
bdadf0f7f3
Explain comments at the start of chapter 3. This is needed since they
...
appear in the examples without any further explanation, and the
tutorial doesn't have this information explicit anywhere else.
Omission reported by Jon Black <jblack@Ridgeway-Sys.com>.
1999-04-29 13:20:25 +00:00
0e1de8bd6b
Minor nits, partly in response to comments from Jonathan Black
...
<jblack@Ridgeway-Sys.com>.
1999-04-29 12:57:32 +00:00
9ef8635c8c
Annotate a couple of entries further.
1999-04-29 04:23:37 +00:00
0041a94e74
Fill in a few holes in the "Very High Level" chapter.
1999-04-29 04:20:46 +00:00
5f342ac2a7
Always use "section" when referring to sections of a document, not "Section".
1999-04-29 02:47:40 +00:00
a4a90ddeac
Clarify that the Modules/ directory is in an unpacked source
...
distribution; this is not clear for Windows users.
1999-04-29 02:44:50 +00:00
c0fcbc1ac6
Update starship URLs.
1999-04-29 02:30:04 +00:00
c7c9a64833
Remove the \date macro; just pick it up from boilerplate.tex.
1999-04-28 18:24:02 +00:00
ea0020571f
Use \rfc to mark some remaining RFC references.
...
Remove comment about full name bug in getaddrlist(); this has been
fixed for a while now.
Work around LaTeX2HTML space-dropping bug.
Mention that the fp attribute can be used to read the message body.
1999-04-28 18:11:09 +00:00
ea07f2751a
setup_column_alignments(): Adding valign=baseline to the <td> tag
...
makes the alignment work on Navigator as
well as IE. Uglier HTML, but it looks
right.
1999-04-28 17:11:21 +00:00
250ba78565
Let's try again: new assertion.
1999-04-28 16:57:01 +00:00
610172b0de
Removed (empty) description of \optional from the "Inline Markup"
...
section; that's not really the right place for it.
1999-04-28 16:54:00 +00:00
2f4bebd28c
Fill in a few holes.
1999-04-28 16:43:11 +00:00
ac3dc83eb6
Fix up the HTML generated for envdesc and macrodesc environments.
...
Make it possible for the user to tell the difference. ;-)
1999-04-28 16:42:29 +00:00
d02573d13b
Handle \p and \op in parameter lists for the environment and macro
...
description environments.
1999-04-28 16:33:04 +00:00
4050e00e41
Adjust the message that gets added to the bottom of each page about
...
where to send comments.
1999-04-28 15:06:08 +00:00
0a0fd595b3
\filenq: Like \file, but don't use single-quotes; this looks better
...
in tables.
1999-04-28 14:59:44 +00:00
f74e5b7936
Control the layout of output tables a little better so they're easier
...
to debug. Small code cleanup around tables.
1999-04-28 14:58:49 +00:00
cf282cdafb
Point to the library reference manual for os.path documentation (in
...
macpath section).
1999-04-28 14:04:36 +00:00
79189b5fd5
do_cmd_seetext(): Clean up so we get proper nesting of <div>s. This
...
fixes a rendering problem on IE5.
General adjustments to the table* environments, including using
<thead> and <tbody>. Attempt to adjust the vertical alignment of the
table cells so that the baseline of the first cell matches the
baseline of the remaining cells: When the first cell is small and the
second cell of the same row is multi-line, the first cell was
vertically centered by default. Specifying valign=baseline fixes the
problem on IE, but Netscape seems to ignore both valign=top and
valign=baseline (even though valign is NS's fault!). Make the
horizontal alignment of 'p' columns left instead of center (for the
headings).
1999-04-28 13:54:30 +00:00
505c49199a
Added "See also" reference to PyOpenGL.
1999-04-27 18:05:06 +00:00
dcf17f3860
mhlib is now documented.
1999-04-23 22:24:12 +00:00
a4966647ec
Markup consistency.
1999-04-23 22:22:27 +00:00
1c7cd63a2b
Nits.
1999-04-23 22:03:00 +00:00
957ac3fadb
Add section for the sha module.
1999-04-23 21:52:18 +00:00
154fc6dcf7
Patch from Greg Ward adding descriptions of S_IMODE() and S_IFMT(),
...
and an explanation of why any of stat.S_*() would be used instead of
os.path.is*(). (With some really small enhancements by me.)
1999-04-23 20:54:57 +00:00
24aca83dbd
Fixed typo and font-control problem reported by Detlef Lannert
...
<lannert@lannert.rz.uni-duesseldorf.de>.
1999-04-23 20:33:59 +00:00
29cf682b71
Clarifications on the first(), next(), and previous() functions, based
...
on comments from Detlef Lannert <lannert@lannert.rz.uni-duesseldorf.de>.
1999-04-23 20:32:59 +00:00
861192120b
Fix a grammatical error reported by Detlef Lannert
...
<lannert@lannert.rz.uni-duesseldorf.de>.
1999-04-23 20:07:02 +00:00
ec8b905bd4
Fix a couple of typos reported by Detlef Lannert
...
<lannert@lannert.rz.uni-duesseldorf.de>.
1999-04-23 20:01:17 +00:00
16214fb017
Fix a couple of grammatical errors reported by Detlef Lannert
...
<lannert@lannert.rz.uni-duesseldorf.de>.
1999-04-23 20:00:53 +00:00
4aa4f30759
Work-around LaTeX2HTML space-dropping bug.
1999-04-23 17:30:40 +00:00
87b8f318b0
Fixed some logical markup nits.
...
Added a pointer to Grail in the see-also section, since it's used as
an example.
1999-04-23 17:26:24 +00:00
deb7e096d3
Logical markup.
1999-04-23 17:11:53 +00:00
806764bee4
No, __repr__() does not accept a parameter other than self.
1999-04-23 17:03:21 +00:00
0fbec55e23
Shorten the section title.
...
Adjust markup to be a little more consistent with the rest of the
document.
1999-04-23 16:44:53 +00:00
eea97ea063
Shorten the section title.
1999-04-23 16:07:38 +00:00
86bd5e48c3
Shorten the section title.
...
Fix a couple of grammatical errors.
1999-04-23 16:02:30 +00:00
7475e04fad
Work around a space-dropping problem in LaTeX2HTML.
...
Clarify the usage of a parameter.
1999-04-23 15:57:23 +00:00
ae35aa8b63
Added "See also" sections linking to binascii.
1999-04-23 15:52:18 +00:00
ee4d54ea33
Refer to the binhex module, not the non-existent hexbin module.
...
Added a "See also" section.
1999-04-23 15:42:36 +00:00
26f7cfe9c7
Fix some glaring markup consistency problems (presentation was
...
broken).
Added a "See also" section.
1999-04-23 15:41:53 +00:00
10682c28b4
Added a couple more requests from users.
1999-04-23 15:15:58 +00:00
812860e81d
Hack places where '--' should appear as literal output but the -- was
...
(properly) converted to - by LaTeX2HTML.
1999-04-23 14:46:18 +00:00
d960dc81b5
Fix square brackets around optional parameters to macros.
1999-04-23 14:44:53 +00:00
7a737dffc4
General small improvements and fixes.
1999-04-23 14:41:44 +00:00
ffbe68723a
Make internal module references hyperlinks wherever it makes sense.
1999-04-22 21:23:22 +00:00
7b8b125fa6
Remove bogus characters in code sample.
1999-04-22 21:19:53 +00:00
fcf94d4edd
Work around LaTeX2HTML comment-handling bug.
1999-04-22 20:55:59 +00:00
4a406c619b
Shorten the section title.
1999-04-22 20:52:44 +00:00
c4a623ebdc
Add command line flags to just list the files that contain the
...
offending lines or to include line numbers in the output.
1999-04-22 20:32:21 +00:00
c8c40ff699
Added a "See also" section with some external references.
1999-04-22 20:16:02 +00:00
4e28c593ad
Markup nits.
...
Make module references hyperlinks.
1999-04-22 18:25:47 +00:00
b7168c3a07
Clean up lots of mark up.
1999-04-22 17:53:37 +00:00
79936fe73f
Added descriptions of the various exceptions, based on the docstrings.
...
Various small cleanups.
1999-04-22 17:23:34 +00:00
c8993aad10
Logical markup and small nits.
...
Don't refer to the STDWIN chapter; chances are really good it wasn't
included. ;-)
1999-04-22 16:50:40 +00:00
12a956921f
Make some module references hyperlinks.
1999-04-22 16:47:27 +00:00
b774550ba5
Minor logical markup nits.
...
Make some module references hyperlinks.
1999-04-22 16:46:18 +00:00
dd6c6d9b0a
Clean up some mark up.
1999-04-22 16:45:26 +00:00
e2effbd32d
Fix minor (English) usage nits.
1999-04-22 16:21:09 +00:00
bcd5454d63
Reference to urllib module can be a hyperlink.
1999-04-22 16:17:45 +00:00
4429772ea3
Fix dropped space in the HTML output.
1999-04-22 16:15:34 +00:00
babdda53d5
Make reference to the socket module a hyperlink.
1999-04-22 16:03:30 +00:00
bf0f4346af
Shorten the section title.
1999-04-22 15:53:35 +00:00
47894d2858
Don't describe this module as being a popen() wrapper; that's a little
...
confusing. This is clearly Unix-specific; label it as such.
1999-04-22 15:19:01 +00:00
a694e00085
Remove \platform declaration; this module is generic.
1999-04-22 15:14:11 +00:00
5254a6d682
Move stat to the Generic chapter.
1999-04-22 15:01:44 +00:00
ca69a03dd6
Don't refer to the system documentation as "man pages"; too
...
Unix-centric. Note that this can be used with the output of
os.fstat() as well as os.stat() and os.lstat().
1999-04-22 14:55:43 +00:00
7bf96ca32d
Make an assertion.
1999-04-22 14:16:59 +00:00
6532b9b8e0
Updated a comment and the release number.
1999-04-22 14:16:14 +00:00
2ea30f4d8c
Add warning that last() and previous() don't work for hashtable
...
databases (opened using hashopen()), as noted by Skip Montanaro on
comp.lang.python.
1999-04-22 14:06:36 +00:00
693a2c6581
Script to locate uses of \module where the module referred to is not
...
the module being documented at that point in the documentation; these
are candidates for conversion to \refmodule, which produces a
hyperlink in the HTML and PDF versions of the output.
1999-04-22 13:08:09 +00:00
e0208cc83c
Add a couple of items.
1999-04-22 13:05:52 +00:00
adade928be
Fill in a lot of the blanks. Add a start to the LaTeX primer section.
...
Use Python-traditional XXX comments instead of square brackets that
aren't as obvious or usefully grepable.
1999-04-22 13:05:27 +00:00
30a535c0f7
Added support for adding environment/macro parameters more cleanly:
...
\op adds an optional parameter, and \p adds a required parameter.
These are only defined in the context of the parameter list parameter
of the envdesc and macrodesc environments.
1999-04-22 13:03:49 +00:00
b9f1f6d90b
Misc. markup nits.
...
All sections get reasonable file names in the HTML output.
1999-04-21 21:43:17 +00:00
2dabd811cd
Fix markup typo.
1999-04-21 21:33:24 +00:00
d146edfaf1
Mark the "Notes:" sections under tables the same way it's done
...
elsewhere in the library reference.
1999-04-21 21:15:35 +00:00
b11d108cdc
The version information here was checked good in 1999, not 199. ;-)
...
Added "See also" reference to zlib home page, even though it's
mentioned in the text.
1999-04-21 18:44:41 +00:00
2799f9d09a
Reflow paragraph to work around LaTeX2HTML dropping a space.
...
Make all references to the os module hyperlinks.
1999-04-21 18:33:47 +00:00
6d20caa2ce
Reflow paragraph to work around LaTeX2HTML dropping a space.
1999-04-21 18:17:11 +00:00
543e19d923
Small nits, more hyperlinks.
...
Added more information for cStringIO.
1999-04-21 18:15:22 +00:00
048b75bd9a
Make references to whrandom hyperlinks.
1999-04-21 18:14:22 +00:00
ec6baaf618
Small markup nits.
1999-04-21 18:13:31 +00:00
54f2fdd1ad
Make the names of the referenced modules hyperlinks; they had not been
...
marked at all.
1999-04-21 18:10:08 +00:00
02e8c0fd2d
Nits. Reference to signal module becomes a hyperlink.
1999-04-21 18:01:14 +00:00
283c588402
Work around LaTeX2HTML comment-handling bug.
1999-04-21 17:57:15 +00:00
318c0b131f
Logical markup nits.
...
Make references to other modules hyperlinks.
1999-04-21 17:29:14 +00:00
c3845a14d3
Logical markup & other small nits.
1999-04-21 17:18:04 +00:00
11bc8cfee3
Explain *why* the copytree() implementation is presented as the
...
example!
1999-04-21 17:08:51 +00:00
e688aec707
Textual references to the glob module can be hyperlinks.
1999-04-21 17:04:43 +00:00
737aa552f4
Markup nit to fixed dropped space in HTML output.
1999-04-21 17:01:15 +00:00
4747f7f61d
Markup nits.
1999-04-21 16:41:40 +00:00
4f6e4fbc1d
Added "See also" reference to xdrlib.
...
Markup nits.
1999-04-21 16:38:53 +00:00
69fa56327a
Markup nits.
1999-04-21 16:29:57 +00:00
8307e21a2a
Mark the references to module names use \module or \refmodule (the
...
closing paragraph used \code).
1999-04-21 16:29:18 +00:00
6ed122a334
Important fix mentioned by The Dragon De Monsyne: the sendmail()
...
method does _not_ disconnect the connection when it throws a
SMTPHeloError!
1999-04-21 16:19:16 +00:00
a889add5d6
Oops; minor nit in example: none of the other interactive examples
...
show the "trailing" prompt, so don't show it here!
1999-04-21 16:00:24 +00:00
ca675e491b
do_cmd_funcline(): Remove some bogus generated stuff from the output
...
(some text was only intended for the index).
1999-04-21 15:58:58 +00:00
3d815bd1c7
Added link to xdrlib module in "See also" section.
1999-04-21 15:57:29 +00:00
085b8121eb
Fix some remaining index & consistency nits. (Many data member
...
references were being omitted from the general index.)
1999-04-21 14:00:29 +00:00
c3fcd6fa0e
Added index entry for "file objects"; this is appearantly referenced
...
somewhere in the Reference Manual, and someone tried to locate it via
the index. Report on the omission by Stefan Franke
<sfranke@cdc-group.com>.
1999-04-21 13:58:17 +00:00
7ceb5777d7
Added doc for the "module" attribute on the class descriptor objects;
...
omission repoorted by Glyn Webster <glyn@ninz.org.nz>.
1999-04-20 18:18:53 +00:00
ad56dafd62
Added example use of pack_list() to help explain the pack_item
...
parameter. Lack of clarity reported by Matthew Gallagher
<hew@hons.cs.usyd.edu.au>.
1999-04-20 13:41:14 +00:00
4ae52694c9
Updated to reflect additions.
1999-04-19 21:21:28 +00:00
32c562bdec
colorsys docs from David Ascher.
1999-04-19 21:20:13 +00:00
9d15881744
bsddb docs from Skip Montanaro; added interesting links.
1999-04-19 21:19:21 +00:00
e9af64c373
Remove superfluous index entry for posix.popen(); no longer
...
appropriate since popen() is only documented in os.
1999-04-16 19:00:48 +00:00
dac9a4e3db
Added link to Fredrik Lundh's online Tkinter reference material.
1999-04-16 18:26:22 +00:00
31bfbc6bff
Minor nits, include author info.
1999-04-16 14:03:32 +00:00
511281ac00
In list of sequence comparison examples, "=" should be "==". Reported
...
by Mirko Liss <n89553@hrz.uni-paderborn.de>.
1999-04-16 13:17:04 +00:00
0ebd5483be
Removed dbhash from the undocumented list.
1999-04-15 16:05:29 +00:00
460f1dd6b7
Add libdbhash.tex.
1999-04-15 15:12:37 +00:00
666255f5ac
Document the dbhash module, and link to it from appropriate places.
1999-04-15 15:11:40 +00:00
f4cbada3f9
Correct documentation for <file>.read(); Python makes a serious
...
best-effort to return 'size' bytes. Point out that this may mean
multiple fread() calls. Reported by Anders Hammarquist
<iko@iko.pp.se> via the Debian crew.
1999-04-14 14:31:53 +00:00
e79f5c1d2b
Use the standard stylesheet here as well.
1999-04-14 14:28:48 +00:00
6ab98325f7
Use the tools/mkdvi.sh script to generate DVI and PDF output for the
...
library reference now that it's sufficiently capable.
1999-04-14 14:04:39 +00:00
c260c0bcdb
Further refinement, to allow this to handle the library reference as
...
well as the other "manual" documents.
1999-04-14 13:13:32 +00:00
011f6fca31
Typo: "Otherwose" --> "Otherwise" (reported by Joakim Sernbrant
...
<joakim.sernbrant@front.se>).
Misc. small fixes to the logical markup.
1999-04-14 12:52:14 +00:00
79d41ccdd3
Add some support for the module index, so this can be used to build
...
the .aux file for any of the "manual" class documents.
1999-04-14 05:02:06 +00:00
7a64b355c1
For now, comment out the \ignorePlatformAnnotation; the global index
...
doesn't really work with this.
1999-04-13 22:19:21 +00:00
9444df0844
Don't include the verbatim style; the default handling is better.
1999-04-13 22:17:55 +00:00
1cc5899742
Fix problem of LaTeX leakage in the module synopsis tables at the
...
beginning of chapters. Known problem reported by Barry Scott
<barry@scottb.demon.co.uk>.
1999-04-13 22:08:59 +00:00
e331356ff7
Fix availability declaration for popen2 module; report by Barry Scott
...
<barry@scottb.demon.co.uk>.
1999-04-13 22:03:26 +00:00
b9971b9964
Minor cleanup.
1999-04-13 21:39:31 +00:00
592dd78408
Fix availability declaration for stat module; report by Barry Scott
...
<barry@scottb.demon.co.uk>.
1999-04-13 21:38:02 +00:00
31ec33ed60
Work around problems with HTML conversion by making the break and
...
tbreak synopses be all on one line (each). Known problem, most
recently reported by Barry Scott <barry@scottb.demon.co.uk>.
1999-04-13 21:36:44 +00:00
cc10e0469a
Just in case a copy of the documentation gets released somehow...
1999-04-13 21:22:46 +00:00
07bd1d1b7b
Ignore the doc/ directory ("Documenting Python").
1999-04-12 15:41:44 +00:00
bfb092eb86
Misspellling: "occurance" --> "occurrence"
1999-04-09 19:57:09 +00:00
2e1094e4ef
Use #!/usr/bin/env python instead of #!/usr/local/bin/python.
1999-04-09 14:53:35 +00:00
7969f31c4d
Updated documentation by Per Cederqvist. I've added back the
...
documentation sendmail() to reflect the changes by The Dragon
(see smtplib.py checkin).
1999-04-07 15:56:51 +00:00
4f21d54764
Added more "See also" entries, + 1 inline hyperlink.
1999-04-05 22:18:12 +00:00
ea003fcc2a
Fixed latex2html weirdness with footnotes.
1999-04-05 21:59:15 +00:00
45b0aeda3c
correct version info for zlib.
...
add note about module failing with old versions of the library.
update comment that explains that this doc is *still* out of date
1999-04-05 21:55:21 +00:00
93aa0f23a7
Fixed latex2html weirdness with footnotes.
1999-04-05 21:39:17 +00:00
b55ce1e8b6
Fixed latex2html weirdness with footnotes.
1999-04-05 21:32:52 +00:00
52e2d51ef3
Fixed latex2html weirdness for a footnote.
1999-04-05 21:26:37 +00:00
9aa8543c84
open() description: Made it more clear that 'b' should always be
...
added to the mode value for binary files to improve
portability.
Fixed latex2html weirdness with a couple of footnotes.
1999-04-05 21:22:41 +00:00
01553706bf
Added a few items to the "See also" sections at Guido's prompting. Made
...
more references to other modules in the text hyperlinks for the HTML and
PDF versions.
1999-04-05 19:46:21 +00:00
766e0cbde1
Added "doc" target to match the other document-prefix targets.
1999-04-05 19:28:29 +00:00
50ae47b0de
Removed bosities around example code; not sure where that stuff crept
...
in!
1999-04-05 19:26:16 +00:00
1dc3a501a6
Made improvements based on changes just made and comments from
...
Bernhard Reiter <bernhard@csd.uwm.edu>.
1999-04-05 19:00:54 +00:00
275e83489e
Added "Documenting Python" to the index.
1999-03-30 13:43:54 +00:00
2c4e009b66
Fixed a lot of the smaller nits identified in Guido's comments.
...
Filled in some of the "blank" areas, and added another large blank
area for a LaTeX primer. (Still a lot to be done.)
1999-03-29 14:55:55 +00:00
806a467fbf
Where rfc822.Message is mentioned, add a link to the rfc822 module.
1999-03-27 05:45:46 +00:00
7c6a90de8a
Added some rules that affect those little "See also:" sections.
1999-03-25 22:22:45 +00:00
bb584d3f6e
Be more stylesheet friendly.
1999-03-25 22:18:30 +00:00
a608a1df87
Require the verbatim package (similar to the LaTeX version).
1999-03-25 22:17:29 +00:00
cb1f2420ea
Document complex() with string arg.
1999-03-25 21:23:26 +00:00
5fc9c869dd
SIGTERM is no longer caught to call sys.exitfunc.
...
This change was made long ago but the documentation was never updated.
1999-03-25 20:30:00 +00:00
2cafcbb440
Remove \platformof support, since it's been removed from the LaTeX
...
style sheet.
Small nits.
1999-03-25 16:57:04 +00:00
e82f5b3d6e
Added note about ftpmirror.py, since that seems to be one of the most
...
requested Python tools/examples.
1999-03-25 05:04:17 +00:00
9b8afdee44
Use more recent option to \pdfdest to not change the zoom factor.
...
This is in response to a comment from Wes Rishel <wes@rishel.com>.
1999-03-24 14:16:17 +00:00
8be229650d
Document new builtin buffer(). Greg Stein.
1999-03-19 19:10:14 +00:00
7d5f5dd6aa
Added htmldoc, to generate the HTML for "Documenting Python".
1999-03-18 19:08:47 +00:00
1468d77ff8
Add "Documenting Python" to the list of processed documents.
1999-03-18 19:07:04 +00:00
03dffcce0e
LaTeX2HTML support for the ltxmarkup package.
1999-03-18 16:42:28 +00:00
9466b9a10d
Add some (commented out) macros to change the page size to the size of
...
typical published manuals, so people can more easily see what they're
really asking for. ;-)
Revise the verbatim environment: simple implementation, but more
compatible if a document also add \usepackage{verbatim} at the
beginning.
Declare \modindex, \bimodindex, \exmodindex, and \stmodindex
obsolete. These still work just fine, but \declaremodule should be
used instead. The obsolete macros will print a warning on standard
out.
1999-03-18 16:18:27 +00:00
596766772e
Documented FTP.set_pasv().
1999-03-18 16:08:54 +00:00
e3fd1064de
Make this simpler; don't care about the paper size. Require that the
...
files exist in the current directory.
Add "Documenting Python" to the list of documents listed.
1999-03-18 14:57:53 +00:00
154d909993
Note that abspath() was added in 1.5.2.
1999-03-17 22:25:11 +00:00
90fc0a71a5
Be sure "make" understands the "doc" target is phony.
1999-03-17 16:06:51 +00:00
8d2c0c2ab4
Fixed minor nits, added index entries to make these easier to find for people
...
not familiar with Unix terminology.
1999-03-16 16:40:01 +00:00
c43e6a2f31
Ignore some more files kept by mkhowto --keep.
1999-03-16 16:14:51 +00:00
15087437d5
Add support for "Documenting Python".
1999-03-16 16:11:27 +00:00
8df362cf97
Removed the embedded sections showing module documentation; just
...
\input the module template.
1999-03-16 16:10:31 +00:00
acffaee46e
New document: "Documenting Python".
1999-03-16 16:09:13 +00:00
1d8f07acbd
Markup for documenting LaTeX macros and environments.
1999-03-16 16:08:26 +00:00
f03fdbc063
Added the new sections from Skip Montanaro.
1999-03-15 15:47:30 +00:00
658cef0141
Preliminary mhlib and telnetlib documents from Skip Montanaro -- thanks, Skip!
1999-03-15 15:44:18 +00:00
bf5a6d2eb4
Fixed tons of small markup problems.
1999-03-12 19:57:38 +00:00
b3a20bc44c
Added availabililty annotations to respond to concerns of /F.
1999-03-12 18:34:21 +00:00
4b1a07ae18
Fixed grammatical error reported by Donald Wallace Rouse II
...
<dwr2@ix.netcom.com>.
1999-03-12 18:21:32 +00:00
93503ca57b
Fixup the module keys. There were some problems with hosting / processing
...
file HTML files on Windows machines do to case insensitivity.
1999-03-12 16:24:22 +00:00
be110c1706
Updates based on comments from /F.
1999-03-12 15:27:35 +00:00
87a42cd61b
Add support for <platform>, some cleanup of module section after
...
creating the <moduleinfo>.
1999-03-11 17:35:12 +00:00
ee84d5972f
Lots of nits to respond to various comments from users.
1999-03-10 17:25:30 +00:00
dc12ec8ca0
Fix a number of typos and small grammatical nits pointed out by Detlef
...
Lannert <lannert@lannert.rz.uni-duesseldorf.de>.
Added a comment explaining the cast in the method table for the
keyword arguments sample code, in response to another comment by
Detlef.
1999-03-09 18:36:55 +00:00
39fc1bc329
Added note about __builtin__._ to section dicussing classes of
...
reserved names, just to avoid confusion on the part of users.
1999-03-05 18:30:21 +00:00
1acb8740eb
Oops, missed a couple of substitutions in the templates.
1999-03-04 21:33:55 +00:00
b41f97d6a0
Pass in the 'Send comments to ...' on the mkmodindex command line,
...
just like we do for mkhowto.
1999-03-04 21:25:05 +00:00
5f7832d125
Allow many more aspects of the generated page to be parameterized, and
...
add a useful usage message. Use 'mkmodindex --help' to display it.
1999-03-04 21:19:57 +00:00
6de28bd2a8
Added "Internet Config" to index.
1999-03-04 19:00:26 +00:00
62cc360e38
add_module_idx(): If \ignorePlatformAnnotation is used, only ignore
...
the specified annotation, not any annotation.
1999-03-04 18:41:17 +00:00
35c3ffdc3f
Fixed description of WSTOPSIG(), added WTERMSIG(). Problem reported
...
by Jonathan Giddy <jon@dgs.monash.edu.au>.
1999-03-04 14:08:10 +00:00
aaa0d9a3a4
Record the value of $TEXINPUTS in the transcript.
...
Job.message(): New method. Takes care of writing a message to the
user and adding it to the transcript.
1999-03-03 21:57:58 +00:00
d8ee0e6ca5
Oops, missed version number for pdfTeX. Updated.
1999-03-03 21:44:10 +00:00
41dee84a40
Lots of small updates.
1999-03-03 21:39:19 +00:00
b1d839866c
Obsolete; use the Python version instead.
1999-03-03 20:28:17 +00:00
6b12b1ec1d
Switch to the Python version of mkhowto.
1999-03-03 20:27:10 +00:00
8b88093b95
Re-written mkhowto in Python; this should be at least a little more
...
portable.
Several things that had been done by running a python script are now a
matter of importing the right module and running a function with a few
parameters.
1999-03-03 20:24:30 +00:00
749f943a6b
process(): New function that contains the "orchestration" of the
...
actual work.
main(): Just handle the command line and filename determination,
calling process() to do the work.
These changes make this more import-friendly.
1999-03-03 19:36:23 +00:00
7c8754fafb
process(): New function that contains the "orchestration" of the
...
actual work.
main(): Just handle the command line and filename determination,
calling process() to do the work.
These changes make this more import-friendly.
1999-03-03 19:25:56 +00:00
aa99a5071e
Be a little more friendly for the generation of the text version: for
...
"blank" navigation icons, use ALT="" instead of ALT="blank"; also add
ALIGN=CENTER for the table, to get a slightly better affect in the
text (the table is full-width, so this doesn't change the appearance
when browsing the HTML).
1999-03-03 16:21:34 +00:00
a54a887f66
"\platform{UNIX}" should really be spelled "\platform{Unix}".
1999-03-02 17:03:42 +00:00
f6863c1909
Added \platform annotations.
1999-03-02 16:37:17 +00:00
46a9438c43
Add information about adding the portability statement.
1999-03-02 16:24:22 +00:00
7f492ad7b8
Be more flexible to support platform annotations.
1999-03-02 16:22:56 +00:00
75ab7a6fa4
Clean up *.pla files -- platform annotation information.
1999-03-02 16:22:26 +00:00
521835c541
Ignore *.pla -- the platform annotation information. Also, remove it for
...
'make clean'.
1999-03-02 16:20:42 +00:00
d70091eade
Ignore *.pla -- the platform annotation information.
1999-03-02 16:19:37 +00:00
0c275fa856
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
557460cb7a
swallow_newline(): Removed function; not really needed. Modified all call
...
sites.
do_cmd_ignorePlatformAnnotation(),
do_cmd_platform(),
do_cmd_platformof(): New functions to support platform dependency
information.
process_all_platformofs(): New function to post-process \platformof macros
using information collected during the initial pass.
process_python_state(): New function. Call all post-processing functions
defined in this file to avoid having to have too much knowledge of
the internals for this stuff in l2hinit.perl.
1999-03-02 16:05:35 +00:00
2383f6dbbc
Improve handling of module index, to deal with platform annotations a little
...
better.
1999-03-02 16:00:37 +00:00
01bc01c82e
Changes to accomodate the global module index and platform annotations.
1999-03-02 15:58:20 +00:00
368b16ad2b
Only use 4 columns in the module index, to accomodate platform annotations.
1999-03-02 15:56:19 +00:00
43b34da656
extract_tb(): Only describe this function once. Problem reported by
...
Jonathan Giddy <jon@dgs.monash.edu.au>.
1999-02-26 18:51:21 +00:00
390636382a
Typo: "Availabilty" --> "Availability"
...
Thanks to /F!
1999-02-26 14:05:02 +00:00
51027c4173
Added note about comments, from Christopher Petrilli.
1999-02-24 22:36:44 +00:00
16e81f4484
Update some of the top comments and shorten title of the first
...
section.
1999-02-24 19:57:14 +00:00
093c97a36f
ignore_from_idx(): Fixed bug in regular expression.
1999-02-24 18:39:47 +00:00
684f78fafe
Add target for modindex.html; a combined lib+mac module index. Also
...
built with target "all".
1999-02-24 17:34:12 +00:00
2ef38a7a42
Script to combine module index files. Given a list of files that look
...
like modindex.html, create a combined modindex.html file that lists
all the modules. Takes the same parameters as buildindex.py.
1999-02-24 17:33:07 +00:00
1b102456a6
Ignore a file called modindex.html.
1999-02-24 17:13:54 +00:00
711fe02ac3
process_nodes(): New function.
...
main(): Moved the node processing between input and ouptut to
process_nodes().
1999-02-24 16:36:48 +00:00
f2b4554403
Document the correct class hierarchy for SystemExit. It is not an
...
error and so it derives from Exception and not SystemError.
1999-02-24 00:27:14 +00:00
b6cf9a4fc4
Script to help identify undocumented modules. Use -h or --help for
...
usage information.
1999-02-23 23:07:48 +00:00
8cdee961bf
Dictionaries are created using the "{...}" notation, not the "..."
...
notation. Problem reported by Magnus L. Hetland <mlh@idt.ntnu.no>.
1999-02-23 18:50:38 +00:00
264bd59221
1. Clarify that immutability isn't entirely the same as unchangeable
...
value (because of immutable containers containing mutable objects).
2. Document that func_code, func_defaults and func_doc / __doc__ are
now writable.
1999-02-23 16:40:55 +00:00
1ec71cb556
Incorporated updates to describe geturl() by Sjoerd Mullender
...
<Sjoerd.Mullender@cwi.nl>.
1999-02-22 22:42:14 +00:00
ba21d10d9b
Added note about *static* after description of *shared*.
1999-02-22 18:21:17 +00:00
00a3a65cc0
Refer to the right RFC in the intro.
1999-02-22 17:12:42 +00:00
0fb7a37667
Reflect the released version.
1999-02-22 15:58:09 +00:00
9226d8e8a8
Removed "This will be discussed later." where it's not. Reported by
...
Clay Spence <cspence@sarnoff.com>; see entry in ../TODO.
1999-02-22 14:55:46 +00:00
7d9b13325d
Other chapter titles refer to collections of modules as "Services"; do
...
the same here.
1999-02-22 14:48:00 +00:00
8ece8041c5
Noted report of missing material in the extending & embedding manual,
...
as reported by Clay Spence <cspence@sarnoff.com>.
1999-02-22 14:37:18 +00:00
c411fa6861
Revised description of blank line handling for the interpreter, based
...
on a comment from /F.
1999-02-22 14:32:18 +00:00
fab41f1788
BabylMailbox description: Properly escape the backslashes in the
...
string representations.
1999-02-22 14:26:16 +00:00
b63e77ccb0
Oops, used a \label twice - fix one of them.
1999-02-22 14:14:48 +00:00
180b68b3cf
More reasonable section titles.
1999-02-22 13:45:09 +00:00
76991ec75a
Shorten section title.
1999-02-20 05:20:49 +00:00
199b79c37b
Added descriptions for BabylMailbox and Maildir (Qmail) mailbox
...
objects.
1999-02-20 05:04:59 +00:00
67d229ea76
Shorten section title.
1999-02-20 04:51:16 +00:00
bbac43223c
Shorten a few section titles.
1999-02-20 00:14:17 +00:00
da57365337
Give subsections reasonable file names in the HTML.
1999-02-19 23:48:05 +00:00
342501142d
Added an index entry.
1999-02-19 23:45:06 +00:00
50cdd97ec4
do_cmd_arabic(): Override the l2h-provided version to remove that
...
obnoxious <SPAN CLASS="arabic">...</SPAN> markup.
1999-02-19 23:04:59 +00:00
df5d50d889
Specify the sizes of H? relative to the normal font size as
...
percentages; using "large", "x-large" makes them too big for
some troublemakers. ;-)
(Not specifying them at all causes some browsers to make them the same
size as normal text. ;-( )
1999-02-19 23:03:04 +00:00
56f8185a53
Shortened the short synopsis -- too long.
1999-02-19 22:59:56 +00:00
9f03380d1c
Use more current approach to recording authors.
1999-02-19 22:56:08 +00:00
c60047575d
Shortened the short synopsis -- way too long.
1999-02-19 22:33:51 +00:00
d8a41e6391
Fix an amazing number of typos & malformed sentences reported by Detlef
...
Lannert <lannert@uni-duesseldorf.de>.
1999-02-19 17:54:10 +00:00
f6346345b0
Noted that the module was added in 1.5.2.
1999-02-19 15:46:38 +00:00
4e7c205470
Update description of what modules "look like" when printed.
1999-02-19 15:30:25 +00:00
cd71aa2a38
Use current approach to record documentation author.
1999-02-18 21:13:03 +00:00
2a2f1fe4d5
Record module & documentation author.
1999-02-18 21:10:32 +00:00
6b103f1e12
Documentation for pyclbr and tokenize modules.
1999-02-18 21:06:50 +00:00
4d358b5d23
Added sections for pyclbr and tokenize.
1999-02-18 20:40:26 +00:00
7c829b3179
Remove the "Parsing Python" section. Hurray!
1999-02-18 20:39:44 +00:00
3d7707a87d
More files.
1999-02-18 20:39:04 +00:00
93d762fc7a
Mark <verbatim> elements that represent interactive sessions; these
...
become <interpreter-session> elements.
1999-02-18 16:32:21 +00:00
997eec7cca
Minor adjustments to reflect esis2sgml.py changes.
...
Added "esis" target to only generate the ESIS data.
1999-02-18 16:31:05 +00:00
607aed7a2c
Some adjustments, mostly to make it more general.
1999-02-18 16:30:16 +00:00
4cc902f464
Make the _rmtt regular expression deal with the new CSS-friendly
...
changes to the HTML documentation.
1999-02-18 16:11:12 +00:00
70a66c9d6d
Add notes to __builtin__.float() and string.atof() that the NaN and Inf
...
results are possible but non-portable.
1999-02-18 16:08:36 +00:00
Fred Drake
Guido van Rossum
Jeremy Hylton
Barry Warsaw