Commit Graph

2911 Commits

Author SHA1 Message Date
Fred Drake 20bab56118 Don't worry about the output dirs for the distutils manuals. 2000-04-28 17:45:27 +00:00
Fred Drake 8187cb9664 Added distutils manuals.
Made the attributes more XHTML-friendly.
2000-04-28 17:43:12 +00:00
Greg Ward e78298a6bd Stripped leading 'sec:' from all section labels -- generates bad filenames,
bad link URLs in HTML, etc.
2000-04-28 17:12:24 +00:00
Greg Ward e9792c4563 When building HTML releases, refer to */*.css and */*.html instead of
???/*.css and ???/*.html -- need to pick up the Distutils manuals!
2000-04-28 17:09:17 +00:00
Greg Ward 3abb104356 Added the Distutils manuals. 2000-04-28 17:05:41 +00:00
Greg Ward 0784c335f3 Added the Distutils manuals: inst and dist. 2000-04-28 17:03:26 +00:00
Greg Ward 0862f800d0 Added 'inst' and 'dist' -- the two Distutils manuals. 2000-04-28 16:53:36 +00:00
Fred Drake 3c3507fd4f Documentation patch describing the 'u' and 'u#' format specifiers,
from Brian Hooper <brian_takashi@hotmail.com>.
2000-04-28 14:43:33 +00:00
Fred Drake 638ae9d0bb Support for the special macros used by the distutils documentation. 2000-04-27 21:27:49 +00:00
Greg Ward 38c28e379c Added a note to the section on 'exec' about the need for a trailing newline
in certain circumstances.  (Apparently, this is a CPython problem.)
2000-04-27 18:32:02 +00:00
Fred Drake ac308d0a6f Added a "See also:" section that exhibits the \seerfc markup. 2000-04-26 18:20:04 +00:00
Fred Drake 64b72b6f4f Define \seerfc within the seealso environment. 2000-04-26 18:13:58 +00:00
Fred Drake 37cc0c0e9f ref_module_index_helper(): Use "my" instead of "local".
get_rfc_url():  New function; returns the URL for a numbered IETF RFC.

do_cmd_rfc():  Use get_rfc_url() instead of hard-coding in the HTML
               formatting.

do_cmd_seerfc():  New function.

do_env_definitions():  Small change to avoid "local".
2000-04-26 18:05:24 +00:00
Fred Drake c009d198db Removed some extraneous and confusing parenthesized expressions.
Noted by Skip Montanaro <skip@mojam.com>.
2000-04-25 21:09:10 +00:00
Greg Ward 4a9e72266d Added section headers for "Extending the Distutils" section (just
a reminder to myself).
2000-04-25 02:57:36 +00:00
Greg Ward 87da1ea127 Patch from Andrew Kuchling: document the new multiple pattern feature in the
manifest template.
2000-04-21 04:35:25 +00:00
Greg Ward d5767a5e43 Reformatted wide paragraphs. 2000-04-19 22:48:09 +00:00
Greg Ward 4eaa3bfed0 Reverted '\var' in the "standard installation location" table to '\filevar'.
Reformatted wide paragraphs.
2000-04-19 22:44:25 +00:00
Greg Ward c402fa122f Dropped '\tilde' and '\bslash' definitions. 2000-04-19 22:40:34 +00:00
Greg Ward 4756e5fb1c Changed '\tilde' and '\bslash' to the standard '\textasciitilde' and
'\textbackslash'.
2000-04-19 22:40:12 +00:00
Greg Ward 95da443447 Removed '\package' definition. 2000-04-19 22:36:33 +00:00
Greg Ward 1ecc251538 Changed '\package' to \module'. 2000-04-19 22:36:24 +00:00
Greg Ward a021acacfb Changed '\option' to '\longprogramopt' wherever it referred to a command-line
option.
2000-04-19 22:34:11 +00:00
Fred Drake cebda6f5f0 Added documentation for WindowsError; omission noted by Michal Bozon
<bozon@natur.cuni.cz>.

(Mark Hammond, other Python/Windows cognoscenti: please check this!)
2000-04-17 17:42:00 +00:00
Fred Drake e99d1dbc74 Clarify the description of the else clause for try/except, and add an
explanation of why you'd want to use it.

Based on a question from Michael Simcich <msimcich@accesstools.com>.
2000-04-17 14:56:31 +00:00
Greg Ward 46b98e35fd Various wording/formattin tweaks.
Started spewing "Creating Built Distributions" section.
2000-04-14 01:53:36 +00:00
Fred Drake 9cf7587fdc Update change to version_info structure. 2000-04-13 17:51:58 +00:00
Fred Drake 4d65d73686 Document hexversion (incompletely explained) and version_info (easily
explained).
2000-04-13 16:54:17 +00:00
Greg Ward 502d2b4615 Added note about usual default prefix under Linux (thanks to Peter Funk
for the idea).
2000-04-12 14:20:15 +00:00
Greg Ward 822a86a955 Trying to placate Fred: redefine \tilde and \bslash; document everything.
Still some not-quite-standard definitions in here that I have to fix.
2000-04-12 01:44:35 +00:00
Greg Ward d5faa7ea08 Changed the table of per-platform default installation locations to be
more consistent with the rest of the Python docs.
2000-04-12 01:42:19 +00:00
Fred Drake ee775a194c Make use of \longprogramopt where appropriate. 2000-04-11 19:46:40 +00:00
Fred Drake 2b85341776 Elaborate descriptions of \e, \module.
Describe policy on vertical lines in tables.
2000-04-11 19:08:30 +00:00
Fred Drake ce44498ba8 Revise the description of \programopt, document \longprogramopt. 2000-04-11 18:52:52 +00:00
Fred Drake 493624941a \longprogramopt: New macro. 2000-04-11 18:47:59 +00:00
Fred Drake 0cd6021339 do_cmd_longprogramopt(): New function. 2000-04-11 18:46:59 +00:00
Greg Ward 08c68fc82d LaTeX macros for the Distutils manuals.
Perhaps these should be added to the standard Python style file?
2000-04-11 02:01:52 +00:00
Greg Ward c392caa390 Spewed a bunch more verbiage.
Lots of scattered wording changes.
2000-04-11 02:00:26 +00:00
Fred Drake 8520cc2328 Added reference count information for Py_FindMethod(). 2000-04-10 19:38:24 +00:00
Fred Drake 7357770153 Yet another markup nit: functions that are part of the Python/C API
are still C functions, and should be marked.
2000-04-10 18:50:14 +00:00
Fred Drake 37f41565a8 PyErr_Format():
Remove statement that the return value is always NULL; this is
        generated by the formatting.
2000-04-10 18:46:22 +00:00
Jeremy Hylton 98605b54b4 document PyErr_Format 2000-04-10 18:40:57 +00:00
Fred Drake 0682be4524 letters:
Fix description; lowercase and uppercase are strings, not
        functions!  Noted by Randall Hopper <aa8vb@yahoo.com>.

maketrans():
        Minor markup nits in description.
2000-04-10 18:35:49 +00:00
Fred Drake 8394595f3b Add to the comment a description of the "null" value for returned
PyObject* values.
2000-04-10 18:29:21 +00:00
Fred Drake c2578c5bb6 load_refcounts(),
do_env_cfuncdesc():  Support the "null" value for the refcounts field
        in refcounts.dat.
2000-04-10 18:26:45 +00:00
Fred Drake db2764d941 The reference count field for PyErr_NoMemory() and
PyErr_SetFromErrno() should be "null".
2000-04-10 18:25:09 +00:00
Fred Drake 5e872de6c7 If the refcount field is "null", that's ok; the value will be None. 2000-04-10 18:24:26 +00:00
Fred Drake 729eca1b9d For functions which return a PyObject* but use "null" for the
reference count field, state that the return value is always NULL.

(Useful for some PyErr_*() flavors.)
2000-04-10 18:23:47 +00:00
Fred Drake 0a863da1f8 cfuncdesc environment:
When processing the optional parameter, don't append any text;
        let the pre-processor supply all of it.
2000-04-10 18:21:38 +00:00
Fred Drake adb272ceee do_cmd_datalineni(): New function, to implement the non-indexing form
of \dataline.
2000-04-10 17:47:14 +00:00
Greg Ward c248baecb3 Moved definition of \XXX command out to distutils.sty. 2000-04-09 20:55:35 +00:00
Greg Ward 6002ffc38c Wrote the introduction (including several subsections).
Started writing the "Standard Build and Install" section.
2000-04-09 20:54:50 +00:00
Greg Ward facb8dbaeb Fixed so LaTeX can actually process it, and so it looks like the other
Distutils manual.
2000-04-09 04:32:40 +00:00
Greg Ward 16aafcd85b Got started for real on this manual. Completely untested and unread -- just
checking it in so I can move things around in the CVS repository.
2000-04-09 04:06:44 +00:00
Greg Ward 7593eb3267 Extracted a bunch of Distutils-specific commands and macros to distutils.sty
(also needed by inst.tex).
2000-04-09 03:59:15 +00:00
Fred Drake 9164f88657 Fix Skip's email address in his attribution! (Thanks, Skip!) 2000-04-08 04:53:29 +00:00
Fred Drake e7a8c972d8 Added support for the "Long HTML" version to the build/packaging
process.
2000-04-07 16:27:15 +00:00
Fred Drake c2c46c3751 New example from Skip Montanaro <skip@mojam.com>. 2000-04-07 16:09:59 +00:00
Fred Drake 46f14580cb Describe the purpose of the "long HTML" package. 2000-04-07 14:47:27 +00:00
Fred Drake cff5482d37 Mark RELEASE with the release level ("a2"). 2000-04-06 18:38:30 +00:00
Fred Drake 69ca950d1f Make sure the \declaremodule uses the right name for the module!
Clean up several markup problems & inconsistencies.
2000-04-06 16:09:59 +00:00
Fred Drake 343301aaa4 unichr(),
unicode():  Added \versionadded{} annotations.
2000-04-06 15:06:03 +00:00
Fred Drake 0b72116812 Marc-Andre Lemburg <mal@lemburg.com>:
Added UnicodeType.
2000-04-06 15:05:04 +00:00
Fred Drake 56ced2a7e4 Marc-Andre Lemburg <mal@lemburg.com>:
Added note that Unicode strings are picklable.
2000-04-06 15:04:30 +00:00
Fred Drake 5828ad6963 Revised / removed comments about string exceptions (relating to the
standard exceptions), added documentation of UnboundLocalError.
2000-04-06 15:03:01 +00:00
Fred Drake 3cb793e8e8 Marc-Andre Lemburg <mal@lemburg.com>:
Added UnicodeError description.
2000-04-06 14:48:35 +00:00
Fred Drake 61098f201e Marc-Andre Lemburg <mal@lemburg.com>:
Add Unicode strings to the list of marshalable types.
2000-04-06 14:47:20 +00:00
Fred Drake 665dd704a3 Note the exception raised when parameter to chr() is out of range. 2000-04-06 14:45:19 +00:00
Fred Drake 33d51841a3 Marc-Andre Lemburg <mal@lemburg.com>:
Documentation for unichr(), unicode(), update for ord().
2000-04-06 14:43:12 +00:00
Fred Drake 2097ef126b Added entry for codecs module. 2000-04-06 14:26:43 +00:00
Fred Drake 98f8a3d8da Added codecs entry here as part of String Services. 2000-04-06 14:25:28 +00:00
Fred Drake b7979c756c Marc-Andre Lemburg <mal@lemburg.com>:
codecs module documentation, with some preliminary markup
adjustments from FLD.
2000-04-06 14:21:58 +00:00
Fred Drake 9dc30bb956 Marc-Andre Lemburg <mal@lemburg.com>:
Tutorial information about Unicode strings in Python, with some markup
adjustments from FLD.
2000-04-06 14:17:03 +00:00
Fred Drake a4cd2611f4 Marc-Andre Lemburg <mal@lemburg.com>:
API documentation for Unicode support from C.
2000-04-06 14:10:29 +00:00
Fred Drake 8b3ce9e099 But don't do the funny \UNICODE macro; we're trying to get away from
those markups!  <with-mixed-feelings>
2000-04-06 14:00:14 +00:00
Fred Drake f0aff8e759 Patch from Marc-Andre Lemburg <mal@lemburg.com>:
Added Unicode type to the language reference.
2000-04-06 13:57:21 +00:00
Fred Drake 6d5c6bdb25 Removed bogus connect() call in SMTP example; reported by Travis
B. Hartwell <slt5v@cc.usu.edu>.

Removed second copy of the "See also" section!
2000-04-05 22:12:06 +00:00
Fred Drake 71b04dab58 Added reference to the multifile module from the "See also" section
in the mimetools documentation.
Suggested by Skip Montanaro <skip@mojam.com>.
2000-04-05 22:05:15 +00:00
Fred Drake d1a56f4235 Noted by Guido:
Fixed up descriptions of altzone and timezone not to refer to the
0th meridian, which doesn't exist.  Reference is now to UTC.
2000-04-05 15:06:03 +00:00
Fred Drake 898915d7e2 Noted by Guido:
Directionality of up/down were confused.
2000-04-05 15:01:36 +00:00
Fred Drake 43b89b637f Noted by Guido:
Note in the "Caveats" section should refer to the exit() function, not
exit_thread().
2000-04-05 15:00:38 +00:00
Fred Drake bf4041a0a6 Merged in changes from 1.5.2p2 release. 2000-04-04 20:58:39 +00:00
Fred Drake 02ba62141e Merged in changes from 1.5.2p2 release as appropriate. 2000-04-04 20:58:25 +00:00
Fred Drake 12ed36525a Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>
(re-written).
2000-04-04 20:43:50 +00:00
Fred Drake 005f494a7f Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>. 2000-04-04 20:42:38 +00:00
Fred Drake 69fbf33680 Fixed typo in example code; spotted by Everett Lipman
<lipman@sphere.niddk.nih.gov>.
2000-04-04 19:53:06 +00:00
Fred Drake 7d68690d8d Added notes about the eventual disappearance of two-parameter bind(),
connect(), and connect_ex().

I didn't make these deprecation notices since it was never a
documented feature.
2000-04-04 17:48:30 +00:00
Fred Drake 38e5d27cae Merged changes from the 1.5.2p2 release.
(Very rough.)
2000-04-03 20:13:55 +00:00
Fred Drake 659ebfa79e Merge in changes from the 1.5.2p2 release.
Hopefully I got all this right!
2000-04-03 15:42:13 +00:00
Fred Drake eb725cd045 Merged changes from the 1.5.2p2 release. 2000-04-03 15:06:40 +00:00
Fred Drake 6a0d844e76 UserString section:
Small cleanups noted by Detlef Lannert
<lannert@lannert.rz.uni-duesseldorf.de>.

Make the spelling of Unicode always uppercase.
2000-04-03 15:02:35 +00:00
Fred Drake 42934689ea Note that "Unicode" is always capitalized. 2000-04-03 15:00:28 +00:00
Fred Drake 54fd8452a1 Merge in changes from the 1.5.2p2 release. 2000-04-03 04:54:28 +00:00
Fred Drake e15956b465 Merged changes from the 1.5.2p2 release. 2000-04-03 04:51:13 +00:00
Fred Drake 20082d92f2 Merge in changes from the 1.5.2p2 release. 2000-04-03 04:26:58 +00:00
Fred Drake ba82878a3b Merged changes from the 1.5.2p2 release. 2000-04-03 04:19:14 +00:00
Fred Drake a22b576d05 UserString class from Peter Funk <pf@artcom-gmbh.de>. 2000-04-03 03:51:50 +00:00
Fred Drake 9a257b4fd4 Added --numeric option, similar to mkhtml.sh. 2000-03-31 20:27:36 +00:00
Fred Drake 9c26f5dbed Added rule to copy in the icons/ directory. 2000-03-31 20:26:33 +00:00
Fred Drake 3bb719f744 List of subdirs that are generated during the build. 2000-03-31 20:26:00 +00:00
Fred Drake e018beea94 Build rules for the "long HTML" version. 2000-03-31 20:22:29 +00:00
Fred Drake ddc6c276b7 Improve explanation of reference counts for PyString_Concat(). 2000-03-31 18:22:38 +00:00
Fred Drake 38d062d022 Reflect the two new sections in the dependencies. 2000-03-31 18:10:17 +00:00
Fred Drake 3c9f936eee Two new sections. Preliminary. 2000-03-31 17:51:10 +00:00
Jeremy Hylton a12c7a7620 Add PyDict_Copy() function to C API for dicts. It returns a new
dictionary that contains the same key/value pairs as p.
2000-03-30 22:27:31 +00:00
Fred Drake bdcc96c9e3 Changes from 1.5.2p2, plus fix a couple of errors noted by Hernan
Martinez Foffani <hfoffani@sofrecom.com.ar>.
2000-03-29 22:41:52 +00:00
Greg Ward 8e14f05ae6 Fix small errors in description of Mac, Windows installation schemes.
Added comment about "--help" (no value) not working.
2000-03-22 01:00:23 +00:00
Greg Ward 295765630a Third attempt at documenting an installation scheme; this one feels like
it could work--reasonably short and straightforward to document, but
flexible enough that it will be able to handle more than just modules
and extensions in the future.
2000-03-18 15:11:50 +00:00
Fred Drake dee86c644e Script to annotate api.tex with reference count information. 2000-03-15 14:57:59 +00:00
Greg Ward 169f91b808 [from 2000-02-25] Second attempt at describing an installation scheme; this is
the simplified scheme that Guido proposed.  Also already-obsolete,
and saved only for posterity.
2000-03-10 01:57:51 +00:00
Greg Ward 7c1e5f65e3 [from 2000-02-23] Description of the baroque and already-obsolete
installation scheme that Fred Drake and I cooked up.  Only saved for
posterity.
2000-03-10 01:56:58 +00:00
Fred Drake 15861b2a41 Update portability information for the spawn*() functions and related
constants.  Someone will need to fill in information on the spawn*()
functions that aren't listed.
2000-02-29 05:19:38 +00:00
Greg Ward abc52169b7 The "Distributing Python Modules" manual; currently empty (I'll get to it
Real Soon Now(TM).
2000-02-26 00:52:48 +00:00
Fred Drake 0baf773c44 Added entry for libtabnanny.tex. 2000-02-23 15:44:58 +00:00
Fred Drake 3c227eef91 Added dependency on libtabnanny.tex. 2000-02-23 15:44:34 +00:00
Fred Drake 155348be33 Initial version from Peter Funk <pf@artcom-gmbh.de>, with minor
consistency changes and a note that the API may change in the future.
2000-02-23 15:44:08 +00:00
Fred Drake 89af0776cd This branch is for 1.6 & forward. 2000-02-22 18:20:03 +00:00
Fred Drake c29e41df44 Script to help locate markup that LaTeX2HTML has a problem with. 2000-02-21 17:20:16 +00:00
Fred Drake 1e862e8a37 Update the description of int() to include the radix parameter;
omission noted on c.l.py by Aahz Maruch.

Swapped the order of the descriptions of int() and intern() so that
int() comes first (the functions are in alphabetic order).
2000-02-17 17:45:52 +00:00
Guido van Rossum 8006d316bc Added docs for new crc32() function. By Jim Ahlstrom.
(Fred, please check.)
2000-02-16 21:13:37 +00:00
Barry Warsaw 41d84631ba Document the API changes to the nntplib module (exceptions become
classes, NNTP.__init__() grows a new optional argument to set reader
mode on the server).
2000-02-10 20:26:45 +00:00
Fred Drake 2bb43a20ce The dircmp module is now obsolete. 2000-02-03 15:27:26 +00:00
Fred Drake ecb84f8e75 Don't insert extra indentation before <title> elements. 2000-01-20 22:51:14 +00:00
Fred Drake 9093834acb Added item about specific missing entries in the C API manual. 1999-12-23 17:22:13 +00:00
Fred Drake 6a90b5e4d0 Removed a couple of items that got done(!).
Moved a couple to a new "Not worth it" section (explanations were
already there).
1999-12-21 23:02:38 +00:00
Fred Drake 76e6da38c0 Document GetoptError and label error an alias. 1999-12-21 22:50:05 +00:00
Fred Drake b9bdfc6a23 Document 1.5.2+ aspects of the NotANumber exception. (Note that this
is in the development branch, not the maintenance branch!)
1999-12-21 18:45:16 +00:00
Fred Drake 89ab163479 Document that the |mode| parameter to open() is optional and explain how
the default value is determined.
1999-12-21 18:31:30 +00:00
Fred Drake 88f6ca2ce9 Document getgroups(), getlogin(), fpathconf(), pathconf(),
pathconf_names, confstr(), confstr_names, sysconf(), sysconf_names.
1999-12-15 19:39:04 +00:00
Fred Drake d16b5abc07 Markup consistency nits that Guido didn't check. ;-) 1999-12-13 23:34:42 +00:00
Guido van Rossum 5f7a28cdf8 Doc update from Piers Lauder see changes for imaplib.py version 2.16. 1999-12-13 23:29:39 +00:00
Fred Drake 18f7a45324 Document the new stuff in the os module. 1999-12-09 22:11:43 +00:00
Fred Drake d4d4ba3fd2 Update link to PythonWare library page. 1999-12-01 18:44:09 +00:00
Fred Drake 645af9fedd rewrite_descriptor(): Fixup conversion of arguments (simpler).
join_adjacent_elements():  Hack to merge adjacent instances of
        <option>; the source \programopt with GNU-style long options
        created problems with LaTeX2HTML; this removes the evil
        workaround, which should never be necessary from structured
        documents(!).
1999-11-23 21:52:03 +00:00
Fred Drake 8a3b4495df Don't rename \var to <varname>; DocBook is too verbose here.
Do adopt DocBook's <command>, <option>, <envar> names for \program,
\programopt, \envvar.

Add \filenq --> <filename quote="no"> (it has to go somewhere, at
least for now).
1999-11-23 21:48:41 +00:00
Fred Drake d81b1b0ffa Set the date and version to reflect the actual status, not the last
released status.  Has to be changed just before publishing anyway.
1999-11-18 20:57:36 +00:00
Fred Drake 0d6bf0e544 When generating the top-level index to the documents, make sure some
oddball things from the LaTeX get translated to rational values.  This
is mostly to keep things from looking broken in a development tree
when they're not.
1999-11-18 20:56:29 +00:00
Fred Drake 7424242c1c Removed last XXX comment; no further action needed on this one. 1999-11-17 16:09:57 +00:00
Fred Drake 55e93964e6 Preliminary documentation for turtle module (Tk), by Moshe Zadka.
Fixed up a few TeXisms and markup nits, but otherwise unchanged.
Somewhat raw.
1999-11-15 17:03:41 +00:00
Fred Drake 2530d4e32b Added request to please not send HTML email to the newsgroup/mailing
list or to python-docs.
1999-11-12 17:20:40 +00:00
Fred Drake 29a710f2ef Document \citetitle and \programopt. 1999-11-10 22:51:18 +00:00
Fred Drake 37f1574f2e Use \citetitle and \programopt as appropriate. 1999-11-10 16:21:37 +00:00
Fred Drake e15eb35fd0 Use \citetitle as appropriate. 1999-11-10 16:13:25 +00:00
Fred Drake 9fa76f1090 Use \citetitle in several places, and \programopt where appropriate. 1999-11-10 16:01:43 +00:00
Fred Drake 698d5206aa Use \citetitle in several places. 1999-11-10 15:54:57 +00:00
Fred Drake ebe0341109 Use \citetitle instead of \emph. 1999-11-09 20:11:17 +00:00
Fred Drake 356d0ceb7e Use \citetitle in one place. 1999-11-09 20:10:01 +00:00
Fred Drake 268df27c9a Use the new markup as apporpriate. 1999-11-09 19:45:59 +00:00
Fred Drake 6e9ea59a43 Use \programopt in one place. 1999-11-09 19:44:44 +00:00
Fred Drake 91f31eab1c Added citetitle and programopt.
Made var get renamed to varname (more like DocBook).
Other names should probably be changed as well; still waiting for the
DocBook book to arrive.
1999-11-09 19:33:24 +00:00