Commit Graph

2257 Commits

Author SHA1 Message Date
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
Guido van Rossum 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
Fred Drake dbd37dfcff Remove three items. 1999-02-02 19:03:09 +00:00
Fred Drake 215fe2f204 Fix the os/posix documentation issue. 1999-02-02 19:02:35 +00:00
Fred Drake dda199b261 Moved \versionadded to end of description sections. 1999-02-02 19:01:37 +00:00
Fred Drake 12ba7868e4 Moved posixpath to os.path. 1999-02-02 19:00:37 +00:00
Fred Drake 560bcae0f0 Added posixpath, winsound. 1999-02-02 18:59:58 +00:00
Fred Drake 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
Fred Drake bb79438d26 This seems to fix a problem with targeting from the indexes. 1999-02-02 18:57:12 +00:00
Fred Drake 2116d983bf Make \versionadded and \versionchanged less prominant -- neither bold
nor a separate paragraph.
1999-02-02 18:02:48 +00:00
Fred Drake d0bceeeb59 Move \versionadded macros to end of descriptions. 1999-02-02 18:00:40 +00:00
Guido van Rossum 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
Fred Drake dbd72a4e4f Added module synopsis. 1999-02-01 21:27:59 +00:00
Fred Drake 68a8c69499 Take out just about everything and refer the reader to the os module. 1999-02-01 20:23:02 +00:00
Fred Drake b23ee1d899 Make the text generic, and call it os.path instead of posixpath. 1999-02-01 20:20:39 +00:00
Fred Drake 59d8b73cef Remove all references to posixpath; only refer to os.path.
Formalize the xstat() documentation.
1999-02-01 20:19:38 +00:00
Fred Drake 98be47e737 OSError description: "as the by the" --> "as the" 1999-02-01 16:17:40 +00:00
Fred Drake 7281b3b779 Updated comments on version of XML package needed. 1999-01-29 22:35:23 +00:00
Fred Drake 28e66d1c5e Added the info tarball to the tarballs target. Added the README to
the info tarball.
1999-01-29 22:23:25 +00:00
Fred Drake b2c59ab367 A README file for the info tarball. 1999-01-29 22:22:03 +00:00
Fred Drake 1dd152d036 Added support to handle \versionadded in a reasonable way. 1999-01-29 22:12:29 +00:00
Fred Drake 9b0dc53d89 Define %descriptor.class, since it's used. 1999-01-29 21:38:14 +00:00
Fred Drake 279ca75a5b Be a little smarter on some attribute values, making an assumption about
the DTD.
1999-01-29 21:35:50 +00:00
Fred Drake 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
Fred Drake 666e60095b Added the Doc/sgml/ directory to the tarball. 1999-01-29 21:22:55 +00:00
Fred Drake 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
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