76 Commits

Author SHA1 Message Date
Fred Drake
4fa82fa410 Back-port the \ulink macro to the documentation package for Python 2.1.x
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.
2002-08-27 19:50:42 +00:00
Fred Drake
5107a51a65 Add support for the classdesc* environment and the \releaseinfo and
\setreleaseinfo macros added to the CVS head.
2001-06-22 15:51:28 +00:00
Fred Drake
ad1ecbe780 \versionadded: Add support for including an explanatory note along with
the versioning information, similar to \versionchanged.
2001-04-18 17:30:26 +00:00
Fred Drake
b5309a956e Import the alltt package and wrap that environment in a similar way to
the way we handle verbatim, so that it picks up the same indentation and
minipage behavior.
2001-04-10 15:53:06 +00:00
Fred Drake
ab357ecf7f Label classes and exceptions explicitly in the documentation (for their
*desc environments).
2001-03-02 18:57:05 +00:00
Fred Drake
31ab298df6 Remove the dollar sign from the formatting of environment variables --
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.)
2001-01-22 17:50:42 +00:00
Fred Drake
ec77e6590d Fix \withsubitem so that it actually works if the only indexing macro in
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.)
2000-10-30 06:22:22 +00:00
Fred Drake
a33c566138 Avoid using \withsubitem and \ttindex internally; they have not proven
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.
2000-10-29 05:19:16 +00:00
Fred Drake
f61eac425a Remove second horizontal line below table headers; it is just too
distracting.
2000-10-24 02:18:30 +00:00
Fred Drake
da72b93a01 Add new environments: longtableii, longtableiii, and longtableiv, to
support long tables which might break across page boundaries.  Otherwise
identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
Fred Drake
af2b71466a \shortversion,
\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.
2000-09-14 20:11:05 +00:00
Fred Drake
48449985f4 \seetitle: New macro for building reference list content. 2000-09-12 17:52:33 +00:00
Fred Drake
4e607964d1 excclassdesc: New environment. For use in documenting class-based
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.
2000-09-09 06:01:25 +00:00
Fred Drake
de9fec5f99 \citetitle: Format the title, not the optional URL! 2000-08-17 04:25:59 +00:00
Fred Drake
cc2b81e7f3 \py@varvars: Merge the various definitions to be the simplist one that
does everything needed, and discard the older stuff that is not
	being used.
2000-08-03 17:38:30 +00:00
Fred Drake
46346ec14e Try to make sure \code always uses roman (non-italic) text.
Change a 1.6 version number used in a an example in a comment to 2.0.
2000-06-30 17:57:05 +00:00
Fred Drake
51313f164c Define \seeurl in the seealso environment. Two parameters: url, why. 2000-05-09 16:18:44 +00:00
Fred Drake
a6e8339e61 \versionchanged: Added optional parameter for explanation of change. 2000-05-02 17:28:36 +00:00
Fred Drake
64b72b6f4f Define \seerfc within the seealso environment. 2000-04-26 18:13:58 +00:00
Fred Drake
493624941a \longprogramopt: New macro. 2000-04-11 18:47:59 +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
ba82878a3b Merged changes from the 1.5.2p2 release. 2000-04-03 04:19:14 +00:00
Fred Drake
7b8195a209 \programopt: New macro, used to mark command-line parameters in the
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.
1999-11-09 17:02:11 +00:00
Fred Drake
d85b5a418a Move the setting for secnumdepth to the document classes; make the numbering
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.
1999-06-29 18:15:59 +00:00
Fred Drake
66823029a4 \declaremodule: Typo. 1999-05-17 14:57:26 +00:00