Fred Drake
c43e6a2f31
Ignore some more files kept by mkhowto --keep.
1999-03-16 16:14:51 +00:00
Fred Drake
15087437d5
Add support for "Documenting Python".
1999-03-16 16:11:27 +00:00
Fred Drake
8df362cf97
Removed the embedded sections showing module documentation; just
...
\input the module template.
1999-03-16 16:10:31 +00:00
Fred Drake
acffaee46e
New document: "Documenting Python".
1999-03-16 16:09:13 +00:00
Fred Drake
1d8f07acbd
Markup for documenting LaTeX macros and environments.
1999-03-16 16:08:26 +00:00
Fred Drake
f03fdbc063
Added the new sections from Skip Montanaro.
1999-03-15 15:47:30 +00:00
Fred Drake
658cef0141
Preliminary mhlib and telnetlib documents from Skip Montanaro -- thanks, Skip!
1999-03-15 15:44:18 +00:00
Fred Drake
bf5a6d2eb4
Fixed tons of small markup problems.
1999-03-12 19:57:38 +00:00
Fred Drake
b3a20bc44c
Added availabililty annotations to respond to concerns of /F.
1999-03-12 18:34:21 +00:00
Fred Drake
4b1a07ae18
Fixed grammatical error reported by Donald Wallace Rouse II
...
<dwr2@ix.netcom.com>.
1999-03-12 18:21:32 +00:00
Fred Drake
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
Fred Drake
be110c1706
Updates based on comments from /F.
1999-03-12 15:27:35 +00:00
Fred Drake
87a42cd61b
Add support for <platform>, some cleanup of module section after
...
creating the <moduleinfo>.
1999-03-11 17:35:12 +00:00
Fred Drake
ee84d5972f
Lots of nits to respond to various comments from users.
1999-03-10 17:25:30 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
1acb8740eb
Oops, missed a couple of substitutions in the templates.
1999-03-04 21:33:55 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
6de28bd2a8
Added "Internet Config" to index.
1999-03-04 19:00:26 +00:00
Fred Drake
62cc360e38
add_module_idx(): If \ignorePlatformAnnotation is used, only ignore
...
the specified annotation, not any annotation.
1999-03-04 18:41:17 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
d8ee0e6ca5
Oops, missed version number for pdfTeX. Updated.
1999-03-03 21:44:10 +00:00
Fred Drake
41dee84a40
Lots of small updates.
1999-03-03 21:39:19 +00:00
Fred Drake
b1d839866c
Obsolete; use the Python version instead.
1999-03-03 20:28:17 +00:00
Fred Drake
6b12b1ec1d
Switch to the Python version of mkhowto.
1999-03-03 20:27:10 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
a54a887f66
"\platform{UNIX}" should really be spelled "\platform{Unix}".
1999-03-02 17:03:42 +00:00
Fred Drake
f6863c1909
Added \platform annotations.
1999-03-02 16:37:17 +00:00
Fred Drake
46a9438c43
Add information about adding the portability statement.
1999-03-02 16:24:22 +00:00
Fred Drake
7f492ad7b8
Be more flexible to support platform annotations.
1999-03-02 16:22:56 +00:00
Fred Drake
75ab7a6fa4
Clean up *.pla files -- platform annotation information.
1999-03-02 16:22:26 +00:00
Fred Drake
521835c541
Ignore *.pla -- the platform annotation information. Also, remove it for
...
'make clean'.
1999-03-02 16:20:42 +00:00
Fred Drake
d70091eade
Ignore *.pla -- the platform annotation information.
1999-03-02 16:19:37 +00:00
Fred Drake
0c275fa856
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
Fred Drake
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
Fred Drake
2383f6dbbc
Improve handling of module index, to deal with platform annotations a little
...
better.
1999-03-02 16:00:37 +00:00
Fred Drake
01bc01c82e
Changes to accomodate the global module index and platform annotations.
1999-03-02 15:58:20 +00:00
Fred Drake
368b16ad2b
Only use 4 columns in the module index, to accomodate platform annotations.
1999-03-02 15:56:19 +00:00
Fred Drake
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
Fred Drake
390636382a
Typo: "Availabilty" --> "Availability"
...
Thanks to /F!
1999-02-26 14:05:02 +00:00
Fred Drake
51027c4173
Added note about comments, from Christopher Petrilli.
1999-02-24 22:36:44 +00:00
Fred Drake
16e81f4484
Update some of the top comments and shorten title of the first
...
section.
1999-02-24 19:57:14 +00:00
Fred Drake
093c97a36f
ignore_from_idx(): Fixed bug in regular expression.
1999-02-24 18:39:47 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
1b102456a6
Ignore a file called modindex.html.
1999-02-24 17:13:54 +00:00
Fred Drake
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
Barry Warsaw
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
Fred Drake
b6cf9a4fc4
Script to help identify undocumented modules. Use -h or --help for
...
usage information.
1999-02-23 23:07:48 +00:00
Fred Drake
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
Guido van Rossum
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
Fred Drake
1ec71cb556
Incorporated updates to describe geturl() by Sjoerd Mullender
...
<Sjoerd.Mullender@cwi.nl>.
1999-02-22 22:42:14 +00:00
Fred Drake
ba21d10d9b
Added note about *static* after description of *shared*.
1999-02-22 18:21:17 +00:00
Fred Drake
00a3a65cc0
Refer to the right RFC in the intro.
1999-02-22 17:12:42 +00:00
Fred Drake
0fb7a37667
Reflect the released version.
1999-02-22 15:58:09 +00:00
Fred Drake
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
Fred Drake
7d9b13325d
Other chapter titles refer to collections of modules as "Services"; do
...
the same here.
1999-02-22 14:48:00 +00:00
Fred Drake
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
Fred Drake
c411fa6861
Revised description of blank line handling for the interpreter, based
...
on a comment from /F.
1999-02-22 14:32:18 +00:00
Fred Drake
fab41f1788
BabylMailbox description: Properly escape the backslashes in the
...
string representations.
1999-02-22 14:26:16 +00:00
Fred Drake
b63e77ccb0
Oops, used a \label twice - fix one of them.
1999-02-22 14:14:48 +00:00
Fred Drake
180b68b3cf
More reasonable section titles.
1999-02-22 13:45:09 +00:00
Fred Drake
76991ec75a
Shorten section title.
1999-02-20 05:20:49 +00:00
Fred Drake
199b79c37b
Added descriptions for BabylMailbox and Maildir (Qmail) mailbox
...
objects.
1999-02-20 05:04:59 +00:00
Fred Drake
67d229ea76
Shorten section title.
1999-02-20 04:51:16 +00:00
Fred Drake
bbac43223c
Shorten a few section titles.
1999-02-20 00:14:17 +00:00
Fred Drake
da57365337
Give subsections reasonable file names in the HTML.
1999-02-19 23:48:05 +00:00
Fred Drake
342501142d
Added an index entry.
1999-02-19 23:45:06 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
56f8185a53
Shortened the short synopsis -- too long.
1999-02-19 22:59:56 +00:00
Fred Drake
9f03380d1c
Use more current approach to recording authors.
1999-02-19 22:56:08 +00:00
Fred Drake
c60047575d
Shortened the short synopsis -- way too long.
1999-02-19 22:33:51 +00:00
Fred Drake
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
Fred Drake
f6346345b0
Noted that the module was added in 1.5.2.
1999-02-19 15:46:38 +00:00
Fred Drake
4e7c205470
Update description of what modules "look like" when printed.
1999-02-19 15:30:25 +00:00
Fred Drake
cd71aa2a38
Use current approach to record documentation author.
1999-02-18 21:13:03 +00:00
Fred Drake
2a2f1fe4d5
Record module & documentation author.
1999-02-18 21:10:32 +00:00
Fred Drake
6b103f1e12
Documentation for pyclbr and tokenize modules.
1999-02-18 21:06:50 +00:00
Fred Drake
4d358b5d23
Added sections for pyclbr and tokenize.
1999-02-18 20:40:26 +00:00
Fred Drake
7c829b3179
Remove the "Parsing Python" section. Hurray!
1999-02-18 20:39:44 +00:00
Fred Drake
3d7707a87d
More files.
1999-02-18 20:39:04 +00:00
Fred Drake
93d762fc7a
Mark <verbatim> elements that represent interactive sessions; these
...
become <interpreter-session> elements.
1999-02-18 16:32:21 +00:00
Fred Drake
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
Fred Drake
607aed7a2c
Some adjustments, mostly to make it more general.
1999-02-18 16:30:16 +00:00
Fred Drake
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
Fred Drake
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
29fb54f0ca
Update note about the (...) format specifier for PyArg_ParseTuple().
1999-02-18 03:50:01 +00:00
Fred Drake
951eea4733
atof() description: Add information about accepting 'NaN' to produce
...
the NaN value.
1999-02-18 03:49:20 +00:00
Fred Drake
127ed0a71e
Updated list of standard exceptions in section 4.1.
1999-02-17 23:09:05 +00:00
Fred Drake
8e0151725d
Small updates and grammatical adjustments.
...
Remove comment about this manual being out of date from the abstract.
1999-02-17 18:12:14 +00:00
Fred Drake
33698f818b
Removed old dynamic linking chapter.
...
Integrated information on Windows DLLs from Chris Phoenix (Thanks!).
Added "Acknowledgements" area to thank contributing authors.
1999-02-16 23:06:32 +00:00
Fred Drake
2f7bfafe26
Remove all email addresses.
1999-02-16 22:51:09 +00:00
Fred Drake
3de61bc13f
Integrated notes on building extension modules on Windows, by Neil
...
Schemenauer <neil_schemenauer@transcanada.com>.
Thanks, Neil!
1999-02-16 21:14:16 +00:00
Fred Drake
f6838c0f5e
Copy in the stylesheet after latex2html is done.
1999-02-16 20:43:53 +00:00
Fred Drake
fcf57ad959
Copy in the stylesheet after latex2html is done.
1999-02-16 20:28:25 +00:00
Fred Drake
90fdda5404
Become more stylesheet-friendly.
1999-02-16 20:27:42 +00:00
Fred Drake
00d98ee5cc
CSS style sheet for the documentation.
1999-02-16 20:27:08 +00:00
Fred Drake
63f217741e
Bump release to 1.5.2b2.
1999-02-16 20:23:55 +00:00
Fred Drake
f43ce00531
Make sure errors get propogated.
1999-02-16 20:05:43 +00:00
Fred Drake
85a59dd68b
The _O_* constants are defined as O_* in the os module.
1999-02-16 19:41:01 +00:00
Fred Drake
9329e5ec75
Remove "_" from the P_* symbols used with the spawn*() functions.
1999-02-16 19:40:19 +00:00
Fred Drake
c7b72dbbca
Added chapter on Windows modules, including msvcrt and winsound.
1999-02-16 19:18:38 +00:00
Fred Drake
a5fab7f8c8
Added some files to the library reference.
1999-02-16 19:08:16 +00:00
Fred Drake
abfd7d6701
Small grammatical fix; missing comma.
1999-02-16 17:34:51 +00:00
Fred Drake
295fb434ed
Make it clear that Demo/embed/ is from the source distribution.
1999-02-16 17:29:42 +00:00
Fred Drake
beb27bfef7
Make navigation panels more CSS-friendly.
...
Make sure the contents page always has the "table of child links"
turned off; this wasn't being handled properly by latex2html for
"howto" ("article") documents, so just do it ourselves for all
document types.
1999-02-16 17:22:32 +00:00
Fred Drake
e96a31da96
Use the same markup for email addresses as is produced by using \email
...
in the LaTeX sources.
1999-02-16 16:16:37 +00:00
Fred Drake
cce8d2a85a
Adjust cellspacing attribute of the navigation bar tables to get some
...
space between cells on all (major) browsers.
1999-02-16 14:21:54 +00:00
Fred Drake
6f9dd5d719
Remove stuff related to copying the icons directory around -- just
...
isn't needed.
1999-02-15 21:43:55 +00:00
Fred Drake
b8a7d72857
Moved icons into the html directory to avoid pollution of the top level.
1999-02-15 21:42:47 +00:00
Fred Drake
66b989c805
Be explicit about the reference count of the original value of the
...
first parameter to PyString_Concat().
1999-02-15 20:15:39 +00:00
Fred Drake
4d33e4e1a8
HTMLBASE: New variable. Make it easier to check an "installed" copy
...
of the HTML documents using the webcheck target.
When there's not a usable .aux file, use mkdvi.sh --aux instead of
building the .dvi completely. This makes the most difference for the
library reference.
1999-02-15 19:29:08 +00:00
Fred Drake
efa641c45a
Add an optional parameter to make the script run latex only once to
...
generate an .aux file. This can make HTML generation a bit faster
when print formats aren't needed.
Explained parameters in a comment.
1999-02-15 19:27:07 +00:00
Fred Drake
3618c14f72
Use a common definition for $(SUBMAKE) instead of repeating everything
...
all over the place.
1999-02-15 16:50:28 +00:00
Fred Drake
aa1afa8d30
Added availability notes for samefile(), sameopenfile(), samestat()
...
since these are not available on Windows.
1999-02-15 16:34:00 +00:00
Fred Drake
5d59d3df7f
Added --l2h-config option to add additional initialization files for
...
latex2html. Can be useful in setting up things like the upward
external link for the top of the documents.
1999-02-15 16:27:42 +00:00
Fred Drake
ec9fbe90be
Added section "Providing a C API for an Extension Module" by Konrad
...
Hinsen.
"\C{}" --> "C"
1999-02-15 16:20:25 +00:00
Fred Drake
efd146c916
Markup nits.
...
Added section on module objects; described functions in
moduleobject.c.
1999-02-15 15:30:45 +00:00
Fred Drake
69d49d6378
Set target.
1999-02-15 15:02:21 +00:00
Fred Drake
f32834c206
Minor fix that helps out with the index.
1999-02-12 22:06:32 +00:00
Fred Drake
9474d86242
Make sure all HTML pages generated from this section have reasonable
...
names.
Markup nits.
1999-02-12 22:05:33 +00:00
Fred Drake
5761b766b2
L2HARGS: Specify the HTML version we're producing, since this is what
...
we generate anyway.
1999-02-12 21:42:23 +00:00
Fred Drake
2d2b6a0074
Markup nits.
1999-02-12 20:40:49 +00:00
Fred Drake
99cd5735f0
Minor markup nits.
1999-02-12 20:40:09 +00:00
Fred Drake
7b84972450
Use the shorter form of Christopher Petrilli's email address.
1999-02-12 20:09:59 +00:00
Fred Drake
28bc711f5f
Added section for MimeWriter, contributed by Christopher Petrilli
...
<petrilli@amber.org>.
This spells the end of another whole section in the undoc chapter!
1999-02-12 19:26:09 +00:00
Fred Drake
f7bf3b2b06
Added entry for MimeWriter module.
1999-02-12 19:24:02 +00:00
Fred Drake
15799edd34
Make table headers the same color as the navigation bars so they stand
...
out a little better.
Make sure the boxes for the last column of tables always get drawn;
these are often left empty of content when used as a "Notes" column.
They look a little better this way.
1999-02-12 19:23:17 +00:00
Fred Drake
7a9ed71e95
Moved the navigation-bar background color to a variable.
1999-02-12 19:00:38 +00:00
Fred Drake
26b698fa4d
Document <complex #>.conjugate().
1999-02-12 18:27:31 +00:00
Fred Drake
15988fdbbb
Documented __complex__(), made sure all the discipline names hit the
...
index.
1999-02-12 18:14:57 +00:00
Fred Drake
2e1ee3eb19
Fix up some routines to coordinate the "indexsubitem" stuff so that
...
the subitem text is updated correctly when each module section is
processed.
Print [<modulename>] when we start on \declaremodule so we can more
easily track progress during the library reference.
1999-02-10 21:17:04 +00:00
Fred Drake
72e5a901c2
Remove unnecessary <p> from top navigation bar.
1999-02-10 17:35:41 +00:00
Fred Drake
ec5c0b41ae
Revert previous change; there's a better way to do it.
1999-02-10 17:08:00 +00:00
Fred Drake
95474f9696
Change the navigation bar to be a little prettier and more consistent
...
with the python.org style.
1999-02-09 18:45:50 +00:00
Fred Drake
446ab75fcf
New blank icon to match the others in size & color, with without any
...
symbol on it.
1999-02-09 18:27:21 +00:00
Fred Drake
2d1f81ea22
do_cmd_maketitle(): Small nit in creating the "title page".
1999-02-09 16:03:31 +00:00
Fred Drake
1a4c5392b5
Back out some of the fine tuning; something in all that interacted
...
badly in practice and botched the whole thing. Wasn't obvious when
looking at the local effects (which worked), but completely broke
entire pages. ;-(
1999-02-09 15:31:52 +00:00
Guido van Rossum
ce67f06491
Update documentation to reflect changes to Queue.py by Tim Peters.
1999-02-08 18:43:13 +00:00
Fred Drake
dfb4e24431
Respond to suggestion from "Albert" <hat@se-46.wpa.wtb.tue.nl> to add
...
document titles to the list of files.
Also added total page count and a note that comments should be
directed to python-docs@python.org .
1999-02-05 20:50:59 +00:00
Fred Drake
2ff880e2cf
More magic to tighten up a little of the formatting.
1999-02-05 18:31:29 +00:00
Fred Drake
f9918f25b1
Minor nit to prevent dropping a space in the HTML generation.
1999-02-05 18:30:49 +00:00
Fred Drake
d673d481f5
Document sameopenfile(), samestat().
1999-02-03 22:31:30 +00:00
Fred Drake
0256c1f453
Document splitdrive().
...
For all split*(), these split path *into* pairs, not split path *in*
pairs. "Into" can be used for transformations, "in" is for
containment.
1999-02-03 19:24:44 +00:00