Commit Graph

2119 Commits

Author SHA1 Message Date
Fred Drake 75930b31e2 Added table entries for \funcline and \funclineni. 1999-01-29 20:09:27 +00:00
Guido van Rossum 1804dc3c07 Document abspath() (implementation is forthcoming). 1999-01-29 18:05:05 +00:00
Fred Drake 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
Fred Drake fdfd50f815 Convert <version> to &version;. 1999-01-29 16:29:25 +00:00
Fred Drake 7859f17608 A few scribbles toward the DTD. 1999-01-29 16:21:20 +00:00
Fred Drake 6bcc53c109 Standard ISO entities. 1999-01-29 16:20:24 +00:00
Fred Drake 2eb07f0945 The OASIS Exchange table model public text. 1999-01-29 15:57:31 +00:00
Fred Drake 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
Fred Drake 3f3b09657f Added table entries for \methodline, \methodlineni. 1999-01-28 23:49:37 +00:00
Fred Drake ae3e574170 "numberic" --> "numeric", two places 1999-01-28 23:21:49 +00:00
Fred Drake 1453a8caf9 Constructor arguments for classes should be called <args>. 1999-01-28 23:10:48 +00:00
Fred Drake 703b70e260 Added \modulesynopsis. 1999-01-28 19:30:49 +00:00
Guido van Rossum 6b86a42c7f Document -OO; "unsafe" optimization that removes docstrings.
Marc-Andre Lemburg.
1999-01-28 15:07:47 +00:00
Fred Drake ffd511248e Add the info "dir" fragment to the info tarball. 1999-01-27 18:50:21 +00:00
Fred Drake 8d7919d754 Fragment of an info "dir" file for the Python documentation. 1999-01-27 18:49:44 +00:00
Fred Drake ffc4811a40 Simplify slightly. 1999-01-27 18:40:36 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake 580f4ab5dc Added the files for the repr and ConfigParser modules. 1999-01-27 17:21:09 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake ebe2a12de8 Incorporate changes for patched version of ConfigParser. 1999-01-26 21:49:05 +00:00
Fred Drake 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
Fred Drake bc866ce2e3 Documentation for the ConfigParser module, by Christopher G. Petrilli
(petrilli@amber.org).
1999-01-26 15:47:59 +00:00
Guido van Rossum 9700e9becc Document the default for tabsize in expandtabs(). 1999-01-25 22:31:53 +00:00
Fred Drake a49a4eabbf Add "term" to AUTOCLOSE. 1999-01-22 22:48:24 +00:00
Guido van Rossum d1dbf633ed Header for PyObject_DelItem() mentioned non-existing 3rd argument. 1999-01-22 20:10:49 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake 19a0dba342 Add caveat on partial dependence on the "cl" module, only available on
IRIX systems.
1999-01-20 16:26:09 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake 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
Fred Drake 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
Fred Drake a7998f650a Revised comments on null bytes in pattern string.
Removed "New" from module synopsis.
1999-01-19 20:00:08 +00:00
Fred Drake 6ffa445832 Fix second description of handling 2-digit years (last item in
introductory text).
1999-01-19 19:35:18 +00:00
Fred Drake d6ced7d199 convert(): Change the element name remapping to convert <refmodule>
to <module link>.
1999-01-19 17:11:23 +00:00
Fred Drake f82e4ab617 format_attrs(): Attempt a bit more minimization for SGML output. 1999-01-19 17:10:31 +00:00
Fred Drake 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
Fred Drake 7eca8e5017 Fix typo spotted by Jeff MacDonald <jam@ans.net>. 1999-01-18 15:46:02 +00:00
Fred Drake 589bc63e84 Add a "tarball" target. 1999-01-14 22:35:05 +00:00
Fred Drake 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
Barry Warsaw 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
Fred Drake 3effeedad3 Shorten the name of the <rfc> "number" attribute to "num". 1999-01-14 21:18:52 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake a50a1df588 Added clean and clobber targets. 1999-01-14 18:26:23 +00:00
Fred Drake 54bad44f25 Update to the latest version of Michael Ernst's script. 1999-01-14 18:17:07 +00:00
Fred Drake 3a7a3d745d "Driver" makefile to convert all documents to SGML or XML at once. 1999-01-14 18:13:59 +00:00
Fred Drake 7727416686 Add usage of the "driver" Makefile. 1999-01-14 18:12:33 +00:00
Fred Drake 9d1c3b565f Elaborate a comment on the format of the table that drives the
conversion.
1999-01-14 18:10:09 +00:00
Fred Drake 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
Fred Drake 79cbadc194 Added fixinfo.el to the list of dependencies. 1999-01-14 17:13:03 +00:00
Fred Drake 79ad1f19dc Escape special characters on output. 1999-01-14 17:06:09 +00:00
Fred Drake da71e315bb Update the comments on info files. 1999-01-13 23:02:38 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake 2581704dfa do_cmd_refmodule(): New function to support new \refmodule macro. 1999-01-13 17:06:34 +00:00
Fred Drake 8d43a2937b Added a few items. 1999-01-12 21:31:16 +00:00
Fred Drake fcb7adb6aa Fix the HTML tarball target to generate the HTML if needed instead of
bombing.
1999-01-12 20:32:39 +00:00
Fred Drake dd7610cac9 Bump the date. Seems like fun. ;-) 1999-01-12 19:51:03 +00:00
Fred Drake 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
Fred Drake 39cddb7439 Added \modulesynopsis. 1999-01-12 19:22:11 +00:00
Fred Drake 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
Fred Drake 5a0ca4e55c do_cmd_methodline(): Fixed reference to method name when generating
the output HTML.
1999-01-12 04:16:51 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake 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
Fred Drake b6584cac1e Remove the "lib-" prefix from the name of the info archive. 1999-01-08 15:49:45 +00:00
Fred Drake ed94dde4b9 No longer useful. 1999-01-08 15:48:47 +00:00
Fred Drake dd21c32169 It's finally gone! 1999-01-08 15:40:16 +00:00
Fred Drake f2b5374ba1 Remove obsolete files. 1999-01-08 15:34:06 +00:00
Fred Drake 78104a9b77 Replace most everything but the comment at the top. 1999-01-08 15:33:38 +00:00
Fred Drake c4e9263010 Add a few comments. 1999-01-08 15:32:27 +00:00
Fred Drake c58f346374 New support scripts for HTML->info conversion that use Michael Ernst's new
conversion tools.
1999-01-08 15:27:17 +00:00
Fred Drake 3fe1d32693 New conversion tools for HTML->info from Michael Ernst
<mernst@cs.washington.edu>.

Thanks!
1999-01-08 15:25:29 +00:00
Fred Drake 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
Fred Drake c7dd3e11da Markup nit.
Add module synopsis.
1999-01-07 15:45:55 +00:00
Guido van Rossum 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
Guido van Rossum 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
Guido van Rossum 87e611e441 Replace the docs for reduce with an adaptation of its docstring, which
was actually clearer!
1999-01-06 23:10:51 +00:00
Guido van Rossum 74429eacb5 Add doc for access() and ttyname(). Patch by Sean Reifschneider. 1999-01-06 23:03:43 +00:00
Fred Drake fcc5910090 Preliminary code to mark paragraphs. Seems to work, but very slow. 1999-01-06 22:50:52 +00:00
Fred Drake c553358c63 Remove documentation for whatraw() since it's gone now. 1999-01-06 15:21:19 +00:00
Fred Drake 60adb362df Document the sndhdr module.
Document that the whatsound module is obsolete.
1999-01-05 23:09:12 +00:00
Fred Drake a2e4017394 Shorten the synopsis that gets into the table of contents. 1999-01-05 22:54:49 +00:00
Fred Drake 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
Fred Drake 02e18b4b84 Added missing "from" in IOError description. 1999-01-05 21:42:18 +00:00
Fred Drake 26f0f65653 Remove obsolete comment. 1999-01-05 20:53:43 +00:00
Fred Drake 5d56d3665f Make the documents that have indexes dependent on the buildindex.py
script.
1999-01-05 15:49:39 +00:00
Fred Drake 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
Fred Drake 3b07480a17 trim_ignored_letters(): Simplify a little. 1999-01-04 22:00:56 +00:00
Fred Drake 8d7e11a8c1 Update information on the version of latex2html to use, including
complaint about 98.2b8 problems.
1999-01-04 18:25:38 +00:00
Fred Drake 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
Andrew M. Kuchling 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
Fred Drake 94c4a7976f Added index entries to make it easier to locate directory & file operations. 1998-12-28 21:58:57 +00:00
Fred Drake 8692998018 Added index entries to make it easier to locate directory operations. 1998-12-28 21:58:15 +00:00
Fred Drake 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
Fred Drake 76fa3b73d6 Remove recently documented modules from the undoc list. 1998-12-28 20:53:19 +00:00
Fred Drake 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