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
72e5a901c2
Remove unnecessary <p> from top navigation bar.
1999-02-10 17:35:41 +00:00
ec5c0b41ae
Revert previous change; there's a better way to do it.
1999-02-10 17:08:00 +00:00
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
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
2d1f81ea22
do_cmd_maketitle(): Small nit in creating the "title page".
1999-02-09 16:03:31 +00:00
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
ce67f06491
Update documentation to reflect changes to Queue.py by Tim Peters.
1999-02-08 18:43:13 +00:00
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
2ff880e2cf
More magic to tighten up a little of the formatting.
1999-02-05 18:31:29 +00:00
f9918f25b1
Minor nit to prevent dropping a space in the HTML generation.
1999-02-05 18:30:49 +00:00
d673d481f5
Document sameopenfile(), samestat().
1999-02-03 22:31:30 +00:00
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
0c9608cf1b
Portability fix for [f]statvfs() return tuple: no longer return the
...
f_fsid field, since it's not a scalar on all systems supporting this
call (in particular, it's a tuple of two longs on AIX). Since it's
not particularly useful, just nuke it. Adapted the doc strings too.
1999-02-03 16:32:37 +00:00
dbd37dfcff
Remove three items.
1999-02-02 19:03:09 +00:00
215fe2f204
Fix the os/posix documentation issue.
1999-02-02 19:02:35 +00:00
dda199b261
Moved \versionadded to end of description sections.
1999-02-02 19:01:37 +00:00
12ba7868e4
Moved posixpath to os.path.
1999-02-02 19:00:37 +00:00
560bcae0f0
Added posixpath, winsound.
1999-02-02 18:59:58 +00:00
a9b9bf96fe
Change this to be os.path.
...
Use consistent parameter naming with the os documentation (paths
always named "path" or "path1", "path2"...).
1999-02-02 18:58:33 +00:00
bb79438d26
This seems to fix a problem with targeting from the indexes.
1999-02-02 18:57:12 +00:00
2116d983bf
Make \versionadded and \versionchanged less prominant -- neither bold
...
nor a separate paragraph.
1999-02-02 18:02:48 +00:00
d0bceeeb59
Move \versionadded macros to end of descriptions.
1999-02-02 18:00:40 +00:00
09da65ef2f
Patch by Sjoerd Mullender to placate /F:
...
Clarified (hopefully :-) the documentation of elements and attributes
variables.
1999-02-02 17:55:12 +00:00
dbd72a4e4f
Added module synopsis.
1999-02-01 21:27:59 +00:00
68a8c69499
Take out just about everything and refer the reader to the os module.
1999-02-01 20:23:02 +00:00
b23ee1d899
Make the text generic, and call it os.path instead of posixpath.
1999-02-01 20:20:39 +00:00
59d8b73cef
Remove all references to posixpath; only refer to os.path.
...
Formalize the xstat() documentation.
1999-02-01 20:19:38 +00:00
98be47e737
OSError description: "as the by the" --> "as the"
1999-02-01 16:17:40 +00:00
7281b3b779
Updated comments on version of XML package needed.
1999-01-29 22:35:23 +00:00
28e66d1c5e
Added the info tarball to the tarballs target. Added the README to
...
the info tarball.
1999-01-29 22:23:25 +00:00
b2c59ab367
A README file for the info tarball.
1999-01-29 22:22:03 +00:00
1dd152d036
Added support to handle \versionadded in a reasonable way.
1999-01-29 22:12:29 +00:00
9b0dc53d89
Define %descriptor.class, since it's used.
1999-01-29 21:38:14 +00:00
279ca75a5b
Be a little smarter on some attribute values, making an assumption about
...
the DTD.
1999-01-29 21:35:50 +00:00
3a7ff998ac
fixup_descriptors(): Change the way we look for descriptor nodes;
...
this takes 5 minutes off the conversion of the whole tree by
reducing the number of tree-traversals from 14 to 1.
1999-01-29 21:31:12 +00:00
666e60095b
Added the Doc/sgml/ directory to the tarball.
1999-01-29 21:22:55 +00:00
cb65781d93
Rewrite code that converts the little descriptor environments to build
...
the right <signature>s and <description>. This seems to work a lot
better now!
1999-01-29 20:55:07 +00:00
75930b31e2
Added table entries for \funcline and \funclineni.
1999-01-29 20:09:27 +00:00
1804dc3c07
Document abspath() (implementation is forthcoming).
1999-01-29 18:05:05 +00:00
f339632da0
Define a general entity "&version;" that can be used as the current major
...
version of the Python interpreter. This is \version in the LaTeX format
of the documentation.
1999-01-29 16:42:37 +00:00
fdfd50f815
Convert <version> to &version;.
1999-01-29 16:29:25 +00:00
7859f17608
A few scribbles toward the DTD.
1999-01-29 16:21:20 +00:00
6bcc53c109
Standard ISO entities.
1999-01-29 16:20:24 +00:00
2eb07f0945
The OASIS Exchange table model public text.
1999-01-29 15:57:31 +00:00
7dab6affba
Update the docstring.
...
Lots of changes to get the paragraph marking to work, and not go into
an infinite recursion.
Start to rationalize markup of method signatures; not complete.
find_all_elements(): similar to getElementsByTagName(), but operates
on the not-quite-legal fragments we deal with here.
Simplifies several individual transforms.
fixup_sectionauthors(): Convert \sectionauthor items to <author> just
after the <section>'s <title>.
1999-01-28 23:59:58 +00:00
3f3b09657f
Added table entries for \methodline, \methodlineni.
1999-01-28 23:49:37 +00:00
ae3e574170
"numberic" --> "numeric", two places
1999-01-28 23:21:49 +00:00
1453a8caf9
Constructor arguments for classes should be called <args>.
1999-01-28 23:10:48 +00:00
703b70e260
Added \modulesynopsis.
1999-01-28 19:30:49 +00:00
6b86a42c7f
Document -OO; "unsafe" optimization that removes docstrings.
...
Marc-Andre Lemburg.
1999-01-28 15:07:47 +00:00
ffd511248e
Add the info "dir" fragment to the info tarball.
1999-01-27 18:50:21 +00:00
8d7919d754
Fragment of an info "dir" file for the Python documentation.
1999-01-27 18:49:44 +00:00
ffc4811a40
Simplify slightly.
1999-01-27 18:40:36 +00:00
c5efde8522
Don't build info for the Macintosh module reference by default; it
...
doesn't do well.
1999-01-27 18:30:16 +00:00
aa2aea0e79
\py@linkToName: New macro to consolidate support for most internal
...
hyperlinking in the PDF version. This also allows many of the
macros that do this stuff to be a good bit more readable.
Takes the target name and link content as parameters.
Use \py@linkToName for all internal links.
1999-01-27 17:37:36 +00:00
580f4ab5dc
Added the files for the repr and ConfigParser modules.
1999-01-27 17:21:09 +00:00
9d814c6805
Document the repr module. This removes the entire "Code objects and
...
files, debugger etc." section from "Undocumented Modules"!
1999-01-27 17:20:33 +00:00
da452bf6a7
Don't say that the module defines the "following functions" and then
...
only describe one; say "following function" instead!
Merge the two one-sentence paragraphs into a single paragraph, so it
doesn't look too stupid.
1999-01-27 15:48:23 +00:00
ebe2a12de8
Incorporate changes for patched version of ConfigParser.
1999-01-26 21:49:05 +00:00
9f253dc3ff
\py@modindex: Format the index entry for the module index more like
...
that used in the "normal" index. No visual difference, but
more easily processed by helper scripts.
1999-01-26 19:23:09 +00:00
bc866ce2e3
Documentation for the ConfigParser module, by Christopher G. Petrilli
...
(petrilli@amber.org ).
1999-01-26 15:47:59 +00:00
9700e9becc
Document the default for tabsize in expandtabs().
1999-01-25 22:31:53 +00:00
a49a4eabbf
Add "term" to AUTOCLOSE.
1999-01-22 22:48:24 +00:00
d1dbf633ed
Header for PyObject_DelItem() mentioned non-existing 3rd argument.
1999-01-22 20:10:49 +00:00
43278f01dc
convert(): Added parameter "autoclose", which should be a sequence of
...
general identifiers for which closing tags will be omitted
when SGML is generated. This can be used to tell the markup
generator to drop stuff like </para>. Note that it needs to
be possible for the closing tag to *always* be omitted for it
to be included in "autoclose".
main(): Added command-line option "-a" / "--autoclose" to set the
list of general identifiers passed to the convert() function
as the "autoclose" parameter. The list may only be specified
once (not additive) and GIs should be comma-separated. The
default list includes only "para".
1999-01-20 20:35:05 +00:00
0a5b8de5e2
Modified the "sgml" and "xml" targets to stop if the sub-makes fail in
...
any subdirectory; don't continue with remaining subdirs.
Added "api", "ext", "lib", "mac", "ref", and "tut" targets to only do
submakes in those directories. This is just a lot easier to use than
to cd into the subdir and use make.rules directly.
1999-01-20 17:26:56 +00:00
19a0dba342
Add caveat on partial dependence on the "cl" module, only available on
...
IRIX systems.
1999-01-20 16:26:09 +00:00
9ea3e36419
Move the jpeg module to the SGI section; it is dependent on the "cl"
...
module available on IRIX.
1999-01-20 15:55:20 +00:00
4259f0db04
create_module_info(): If there's a \moduleauthor, move it to an
...
<author> inside the <moduleinfo> element.
Fix problems with paragraph identification.
1999-01-19 23:09:31 +00:00
36dfe58694
isnmtoken(), istoken(): Fix to ensure the regex has to match the
...
entire attribute value.
Add ability to save list of "empty" elements to a file -- enabled by
constant in the code.
1999-01-19 23:03:04 +00:00
2664db9f76
handle_labels(): Fix problem for document fragments containing more
...
than one "root" that prevented all the <label id=...> items
from being promoted to id attributes on the enclosing chapter/
section/... properly.
1999-01-19 21:46:48 +00:00
a7998f650a
Revised comments on null bytes in pattern string.
...
Removed "New" from module synopsis.
1999-01-19 20:00:08 +00:00
6ffa445832
Fix second description of handling 2-digit years (last item in
...
introductory text).
1999-01-19 19:35:18 +00:00
d6ced7d199
convert(): Change the element name remapping to convert <refmodule>
...
to <module link>.
1999-01-19 17:11:23 +00:00
f82e4ab617
format_attrs(): Attempt a bit more minimization for SGML output.
1999-01-19 17:10:31 +00:00
9bbdce5945
add_module_idx(), add_idx_hook():
...
Change the message printed before running buildindex.py;
"Doing the index..." wasn't clear and could be misinterpreted
with an inappropriate mindset. ;-)
1999-01-19 16:30:10 +00:00
7eca8e5017
Fix typo spotted by Jeff MacDonald <jam@ans.net>.
1999-01-18 15:46:02 +00:00
589bc63e84
Add a "tarball" target.
1999-01-14 22:35:05 +00:00
6038f54b74
Adjust so that we are no longer using special entities for well-known
...
names. These are too much of a pain for occaissional authors.
1999-01-14 21:44:56 +00:00
53610caee2
for method getaddrlist(): Added a note clarifying that all named
...
headers and their continuation lines are parsed.
1999-01-14 21:26:54 +00:00
3effeedad3
Shorten the name of the <rfc> "number" attribute to "num".
1999-01-14 21:18:52 +00:00
d24167baf2
Make <rfc> no longer an empty element but a container. The text
...
currently generated by the LaTeX and LaTeX2HTML processes is generated
here as well, making it more flexible in the SGML version.
Reduce the <args> element so that <optional> goes away; just use
square brackets to indicate what's optional. This makes it easier to
read than the LaTeX, and the processor can do any checking it needs to
in order to make sure it's legit. Possible shortcoming: DSSSL
processors may need more explicit markup. Can probably hack around it
for this case, but we'll see.
1999-01-14 21:18:03 +00:00
f8ebb5521d
Several new functions to re-write tables to be at least partly
...
conformant with the OASIS Exchange model. There's a little more
massage left to do, but not much.
1999-01-14 19:45:38 +00:00
a50a1df588
Added clean and clobber targets.
1999-01-14 18:26:23 +00:00
54bad44f25
Update to the latest version of Michael Ernst's script.
1999-01-14 18:17:07 +00:00
3a7a3d745d
"Driver" makefile to convert all documents to SGML or XML at once.
1999-01-14 18:13:59 +00:00
7727416686
Add usage of the "driver" Makefile.
1999-01-14 18:12:33 +00:00
9d1c3b565f
Elaborate a comment on the format of the table that drives the
...
conversion.
1999-01-14 18:10:09 +00:00
d7acf02290
Adjustments to allow elements with subelements as parameters. This is
...
used to deal with the table headings and entries.
An additional flag in the element table is used to indicate elements
which have no "general" content, but which do have subelement
content. These must be flagged distinctly from empty elements.
Currently used for \lineii, \lineiii, and \lineiv.
1999-01-14 17:38:12 +00:00
79cbadc194
Added fixinfo.el to the list of dependencies.
1999-01-14 17:13:03 +00:00
79ad1f19dc
Escape special characters on output.
1999-01-14 17:06:09 +00:00
da71e315bb
Update the comments on info files.
1999-01-13 23:02:38 +00:00
e36e4e6778
Use \refmodule when we say "use the XXX module instead".
...
For the whatsound module, point to sndhdr.
1999-01-13 17:11:52 +00:00
da94374a86
\seemodule: Fix so that each \seemodule entry gets its own paragraph,
...
so they don't get run together when there's no blank line
between them in the source. The HTML conversion already did
the right thing.
\refmodule: Refer to a module, using a hyperlink in the PDF version.
Visually the same as \module.
1999-01-13 17:09:06 +00:00
2581704dfa
do_cmd_refmodule(): New function to support new \refmodule macro.
1999-01-13 17:06:34 +00:00
8d43a2937b
Added a few items.
1999-01-12 21:31:16 +00:00
fcb7adb6aa
Fix the HTML tarball target to generate the HTML if needed instead of
...
bombing.
1999-01-12 20:32:39 +00:00
dd7610cac9
Bump the date. Seems like fun. ;-)
1999-01-12 19:51:03 +00:00
701f10fbea
Simplify command that extracts the number of pages from a PostScript
...
file; use "grep -c" instead of "grep | wc -l | cut ... | tr ...".
1999-01-12 19:28:41 +00:00
39cddb7439
Added \modulesynopsis.
1999-01-12 19:22:11 +00:00
03dd3efd5a
<writer>.send_paragraph(): Clarify what needs to be done by this
...
method and what it should not do. (Specifically: handling
breaking of last line of preceeding paragraph.)
1999-01-12 18:33:47 +00:00
5a0ca4e55c
do_cmd_methodline(): Fixed reference to method name when generating
...
the output HTML.
1999-01-12 04:16:51 +00:00
4856d01797
Removed a lot of unnecessary comment markers which cause unexplained
...
numbers to appear in the HTML version of the manual.
1999-01-12 04:15:20 +00:00
8e2c9457a2
output_body(): For <address> elements, just skip, since they're
...
always part of the page trailer.
1999-01-11 22:30:34 +00:00
bb3b0028ba
Patches describing the statvfs() and fstatvfs() functions. Additional
...
text about large file support.
All new text by Steve Clift <clift@mail.anacapa.net>, with only minor
revision / addition of markup.
1999-01-11 18:36:23 +00:00
b6584cac1e
Remove the "lib-" prefix from the name of the info archive.
1999-01-08 15:49:45 +00:00
ed94dde4b9
No longer useful.
1999-01-08 15:48:47 +00:00
dd21c32169
It's finally gone!
1999-01-08 15:40:16 +00:00
f2b5374ba1
Remove obsolete files.
1999-01-08 15:34:06 +00:00
78104a9b77
Replace most everything but the comment at the top.
1999-01-08 15:33:38 +00:00
c4e9263010
Add a few comments.
1999-01-08 15:32:27 +00:00
c58f346374
New support scripts for HTML->info conversion that use Michael Ernst's new
...
conversion tools.
1999-01-08 15:27:17 +00:00
3fe1d32693
New conversion tools for HTML->info from Michael Ernst
...
<mernst@cs.washington.edu>.
Thanks!
1999-01-08 15:25:29 +00:00
637ad47e61
convert(): Make sure no line has trailing whitespace. (docfixer.py
...
checks for \n\n as a paragraph separator, LaTeX allows white
space between the newlines.)
1999-01-07 18:47:07 +00:00
c7dd3e11da
Markup nit.
...
Add module synopsis.
1999-01-07 15:45:55 +00:00
cf3ce92ef4
Explain how come that pickle and cPickle, while using the same data
...
format, can produce different pickle strings for the same object.
1999-01-06 23:34:39 +00:00
e51aa5b2cd
Minor clarifications by Sean Reifschneider:
...
- add example of string literal concatenation
- add clarifying comment to the example of the if statement
1999-01-06 23:14:14 +00:00
87e611e441
Replace the docs for reduce with an adaptation of its docstring, which
...
was actually clearer!
1999-01-06 23:10:51 +00:00
74429eacb5
Add doc for access() and ttyname(). Patch by Sean Reifschneider.
1999-01-06 23:03:43 +00:00
fcc5910090
Preliminary code to mark paragraphs. Seems to work, but very slow.
1999-01-06 22:50:52 +00:00
c553358c63
Remove documentation for whatraw() since it's gone now.
1999-01-06 15:21:19 +00:00
60adb362df
Document the sndhdr module.
...
Document that the whatsound module is obsolete.
1999-01-05 23:09:12 +00:00
a2e4017394
Shorten the synopsis that gets into the table of contents.
1999-01-05 22:54:49 +00:00
ccc627200a
write_idxfile(): New function. Isolate format of the external index
...
data file used by buildindex.py.
next_argument_id(): Removed; no longer used.
next_argument(): Doesn't use next_argument_id(), just does the work.
gen_target(), gen_target_name(): Removed, no longer used. The only
place that used them now does the (trivial) work directly.
Lots of little changes so we never have to pass around $br_id values
all over the place. The only places they're used now new IDs are
generated as needed.
1999-01-05 22:16:29 +00:00
02e18b4b84
Added missing "from" in IOError description.
1999-01-05 21:42:18 +00:00
26f0f65653
Remove obsolete comment.
1999-01-05 20:53:43 +00:00
5d56d3665f
Make the documents that have indexes dependent on the buildindex.py
...
script.
1999-01-05 15:49:39 +00:00
7d45f6dcc4
do_cmd_methodline(): New function, implements indexing version of
...
\methodline.
Fixed up support for \withsubitem, hopefully improving the fidelity of
the index a bit.
1999-01-05 14:39:27 +00:00
3b07480a17
trim_ignored_letters(): Simplify a little.
1999-01-04 22:00:56 +00:00
8d7e11a8c1
Update information on the version of latex2html to use, including
...
complaint about 98.2b8 problems.
1999-01-04 18:25:38 +00:00
b75d021081
Typo: "TWELV" --> "TWELVE"
...
Added note at top, since LaTeX style writers like to force name
changes when someone else makes a change to the style. I'm sending a
note to the author reporting the error and asking for an updated
version.
This cannot be distributed in this form. This will be resolved when I
get a response from Ulf Lindgren.
Typo reported by rwolff@noao.edu (Richard Wolff).
1999-01-04 16:15:02 +00:00
f07c328c07
Document the optional mode argument (Z_FLUSH, Z_SYNC_FLUSH, etc.)
...
to the flush() method of compressor objects.
1998-12-31 21:14:23 +00:00
94c4a7976f
Added index entries to make it easier to locate directory & file operations.
1998-12-28 21:58:57 +00:00
8692998018
Added index entries to make it easier to locate directory operations.
1998-12-28 21:58:15 +00:00
cc09e8dc82
Clarified what Python versions the interactivity chapter applies to,
...
and what it doesn't apply to.
1998-12-28 21:21:36 +00:00
76fa3b73d6
Remove recently documented modules from the undoc list.
1998-12-28 20:53:19 +00:00
03a0235793
Print a line to the console reporting the number of index nodes
...
processed. This can be interesting to see.
1998-12-28 20:46:53 +00:00
566c8327f7
Added entry for libshutil.tex.
1998-12-28 20:17:33 +00:00
449e18f459
Add documentation for shutil module.
1998-12-28 20:16:58 +00:00
cd058539a8
Adjust a few niggles that affected the HTML conversion (a couple of
...
"^"s were being dropped in the context of [^...]).
1998-12-28 19:03:24 +00:00
d82af0b8ec
Remove all use of $* in commands; some makes (Solaris 2.5, IRIX 6.X)
...
only expand this in dependency lists. Thanks for Sjoerd Mullendar for
pointing this out.
1998-12-28 15:17:22 +00:00
d358afeec0
Document 'N' format character for Py_BuildValue -- like 'O' but doesn't INCREF.
1998-12-23 05:02:08 +00:00
32f7ae0066
Fix many of the specific targets in links from the index.
...
In a number of places, I called next_argument() instead of
next_argument_id() when the ID was also needed. (7 places)
1998-12-22 23:41:07 +00:00
7d65d388b8
Add the getpass module to $(LIBFILES).
1998-12-22 23:38:11 +00:00
99e2c39b31
Add the getpass module.
1998-12-22 23:37:46 +00:00
5ac2a07fca
Basic documentation for the getpass module.
1998-12-22 23:37:21 +00:00
85220410e0
Bump $(RELEASE).
1998-12-22 22:17:41 +00:00
5cb48a4c98
Added a \versionchanged since the API changed to support
...
namespaces with 1.5.2.
Added an index entry.
Fixed XML expansion: XML is the "Extensible Markup Language", not the
"eXtended Markup Language".
1998-12-22 18:46:13 +00:00
292b9ebfba
Added information on when this was added, allowing us to release the
...
documentation on the Web while people are still using < 1.5.2b1.
1998-12-22 18:40:50 +00:00
Fred Drake
Guido van Rossum
Barry Warsaw
Andrew M. Kuchling