summaryrefslogtreecommitdiffstats
path: root/Doc/texinputs/python.sty
Commit message (Collapse)AuthorAgeFilesLines
* Back-port the \ulink macro to the documentation package for Python 2.1.xFred Drake2002-08-271-0/+15
| | | | | | | since a documentation patch included \ulink. Adding this here makes back-porting further documentation patches easier than having to remove \ulink from the patches. Closes SF bug #598996.
* Add support for the classdesc* environment and the \releaseinfo andFred Drake2001-06-221-0/+15
| | | | \setreleaseinfo macros added to the CVS head.
* \versionadded: Add support for including an explanatory note along withFred Drake2001-04-181-2/+7
| | | | the versioning information, similar to \versionchanged.
* Import the alltt package and wrap that environment in a similar way toFred Drake2001-04-101-0/+21
| | | | | the way we handle verbatim, so that it picks up the same indentation and minipage behavior.
* Label classes and exceptions explicitly in the documentation (for theirFred Drake2001-03-021-15/+15
| | | | *desc environments).
* Remove the dollar sign from the formatting of environment variables --Fred Drake2001-01-221-3/+3
| | | | | too Unix-specific, and not really needed. (Already fixed the HTML formatting, but forgot to mention it in the checkin for python.perl 1.94.)
* Fix \withsubitem so that it actually works if the only indexing macro inFred Drake2000-10-301-10/+5
| | | | | | | | | the content body is the \ttindex macro, which seems to match actual usage. Adjust \funcline to restore the "index sub-item" for functions to be " (in module <name>)" instead of " (in <name>)". This is need to match uses of \withsubitem throughout the documentation. (Not ideal, but gets achieves consistency.)
* Avoid using \withsubitem and \ttindex internally; they have not provenFred Drake2000-10-291-20/+26
| | | | | | to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
* Remove second horizontal line below table headers; it is just tooFred Drake2000-10-241-6/+6
| | | | distracting.
* Add new environments: longtableii, longtableiii, and longtableiv, toFred Drake2000-09-211-3/+36
| | | | | support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
* \shortversion,Fred Drake2000-09-141-0/+3
| | | | | | \setshortversion: New markup to help deal with Python having a "real" version number and an abbreviated version number used to create pathnames to the library installation.
* \seetitle: New macro for building reference list content.Fred Drake2000-09-121-0/+13
|
* excclassdesc: New environment. For use in documenting class-basedFred Drake2000-09-091-0/+19
| | | | | | | | exceptions which have interesting constructor signatures. \pep, \seepep: New macros. Equivalent to \rfc and \seerfc, but referring to the PEP series instead of the Internet RFC series of documents.
* \citetitle: Format the title, not the optional URL!Fred Drake2000-08-171-1/+1
|
* \py@varvars: Merge the various definitions to be the simplist one thatFred Drake2000-08-031-5/+2
| | | | | does everything needed, and discard the older stuff that is not being used.
* Try to make sure \code always uses roman (non-italic) text.Fred Drake2000-06-301-2/+2
| | | | Change a 1.6 version number used in a an example in a comment to 2.0.
* Define \seeurl in the seealso environment. Two parameters: url, why.Fred Drake2000-05-091-0/+9
|
* \versionchanged: Added optional parameter for explanation of change.Fred Drake2000-05-021-2/+8
|
* Define \seerfc within the seealso environment.Fred Drake2000-04-261-0/+9
|
* \longprogramopt: New macro.Fred Drake2000-04-111-0/+2
|
* cfuncdesc environment:Fred Drake2000-04-101-1/+1
| | | | | When processing the optional parameter, don't append any text; let the pre-processor supply all of it.
* Merged changes from the 1.5.2p2 release.Fred Drake2000-04-031-12/+58
|
* \programopt: New macro, used to mark command-line parameters in theFred Drake1999-11-091-0/+5
| | | | | | | | | text. Looks like \program. \citetitle: New macro, used to mark titles of cited works (like the names of the Python manuals). Accepts & discards an optional parameter that is only used by the HTML formatter. Looks like \emph.
* Move the setting for secnumdepth to the document classes; make the numberingFred Drake1999-06-291-1/+0
| | | | | | | for the manual class go one deeper than it previously did (\subsection entries will now be numbered); no change for howto documents. This makes it easier to refer precisely to smaller sections using \ref.
* \declaremodule: Typo.Fred Drake1999-05-171-1/+1
|
* \declaremodule: Make this more robust. Only attempt to add an indexFred Drake1999-05-171-1/+6
| | | | | | | | | | | | entry based on the module type if the type is known. Otherwise, spit out a warning the the module type parameter was bad and generate a "plain" index entry. Without this, the bad module type was emitted as text. Problem noticed by processing Michael Hudson's docs for bytecodehacks.
* Change the look of \seemodule output to fit in better.Fred Drake1999-05-111-10/+16
|
* \filenq: Like \file, but don't use single-quotes; this looks betterFred Drake1999-04-281-0/+1
| | | | in tables.
* Use more recent option to \pdfdest to not change the zoom factor.Fred Drake1999-03-241-1/+1
| | | | This is in response to a comment from Wes Rishel <wes@rishel.com>.
* Add some (commented out) macros to change the page size to the size ofFred Drake1999-03-181-41/+35
| | | | | | | | | | | | | | typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
* Added support for \platform, \platformof, and \ignorePlatformAnnotation.Fred Drake1999-03-021-10/+47
|
* Make \versionadded and \versionchanged less prominant -- neither boldFred Drake1999-02-021-3/+3
| | | | nor a separate paragraph.
* \py@linkToName: New macro to consolidate support for most internalFred Drake1999-01-271-18/+18
| | | | | | | | 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.
* \py@modindex: Format the index entry for the module index more likeFred Drake1999-01-261-1/+1
| | | | | that used in the "normal" index. No visual difference, but more easily processed by helper scripts.
* \seemodule: Fix so that each \seemodule entry gets its own paragraph,Fred Drake1999-01-131-0/+15
| | | | | | | | | 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.
* Make \var work correctly in math mode.Fred Drake1998-11-301-2/+8
|
* Minor nit that fixes a bunch of indexing: the way the classdescFred Drake1998-11-251-1/+2
| | | | | | | | environment saves the name of the last class described, method and member descriptions were not picking it up correctly. Thus, many index entries were described as "( method)" instead of "(FooClass method)". Multiple entries were collapsed in the index when methods/members from multiple classes share the same name.
* \itembreak,Fred Drake1998-09-091-20/+7
| | | | | | \itemjoin: Remove obsolete macros. \itemnewline: Rename to \py@itemnewline, since it's only used internally.
* \moduleauthor,Fred Drake1998-08-101-0/+6
| | | | \sectionauthor: New macros to record attributions; no output.
* Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fiFred Drake1998-07-281-0/+5
| | | | stuff. \ifhtml ...\fi for HTML only.
* \versionadded,Fred Drake1998-07-271-2/+17
| | | | \versionchanged: New macros.
* {tableiv} environment: Four-column table.Fred Drake1998-07-241-0/+10
| | | | \lineiv: Row for {tableiv}.
* \textunderscore: Re-define with a width that's more appropriate for theFred Drake1998-07-231-0/+6
| | | | | | courier font used in Python code. This still isn't *good*, but makes the width about right in most cases. (Exception: it's now a little wide in \var words.)
* Lots of new stuff for "module synopsis support." Public interface consistsFred Drake1998-07-231-51/+151
| | | | | | | | | | | | | | | | | | | | | | | | | | of three macros, one which replaces some of the current conventions used in the module sections: \declaremodule: Requires two parameters: module type (standard, builtin, extension), and the module name. An optional parameter should be given as the basis for the module's "key" used for linking to or referencing the section. The "key" should only be given if the module's name contains underscores, and should be the name with the underscore's stripped. This should be the first thing after the \section used to introduce the module. \modulesynopsis: Requires a single parameter: a short, one-liner description of the module that can be used as part of the chapter introduction. This should probably be placed just after the \declaremodule, but may be placed anywhere in the same section. \localmoduletable: No parameters. If a .syn file exists for the current chapter (or for the entire document in howto docs), a synopsistable is created with the contents loaded from the .syn file. Some re-organization due to module synopsis support. Some \def's changed to \newcommand's.
* Fix the \kbd definition so it didn't leave the courier face on.Fred Drake1998-07-011-1/+1
|
* Added {definitions} environment, which has \term to define indivual terms.Fred Drake1998-05-201-0/+11
| | | | Similar to {description}.
* Added definitions for \developer, \developers, \developersaddress.Fred Drake1998-05-141-0/+3
| | | | Ask Guido if you really want to know why. ;-)
* Set the right page size in the PDF output.Fred Drake1998-05-111-7/+5
|
* \itembreak,Fred Drake1998-05-061-0/+14
| | | | | \itemjoin, \kwindex: Revived definitions to support the Python Reference Manual.
* Fixed \code so word wrapping is allowed.Fred Drake1998-04-281-142/+141
| | | | | | Removed some old stuff. Do better hiding of internal names.