Commit Graph

113 Commits

Author SHA1 Message Date
Fred Drake 712f07082d clean up the underscore mess for the typeset formats so that subscripts
work in math displays (thanks to Bo Peng on the Doc-SIG)
2005-03-24 06:21:37 +00:00
Fred Drake 1592c4c6b2 fix broken usage comment 2005-03-10 04:01:14 +00:00
Fred Drake cdd6e4d753 - fix up internal hyperlink generation in PDF formatting so that links at
the beginning of a paragraph do not generate errors; this affected
  things like \refmodule when it came first in a paragraph
- clean up the .sty file to separate out the treatment of the start
  of a new paragraph
2004-12-01 06:30:31 +00:00
Neal Norwitz 5268c3955a sf #1009373, #1005936. fix underscores in index entries in PDF files.
I couldn't test this, but it didn't break anything and the patch
reported fixed the problem.

Bugfix candidate.
2004-08-21 15:13:52 +00:00
Fred Drake 862b46bbc1 add a heavy box around warning notices to make them really stand out in the
PDF and PostScript versions of the docs (the CSS already does this for HTML)
2004-03-31 08:08:34 +00:00
Fred Drake 29f5933fcb add support for \e to the {alltt} environment 2004-02-10 18:30:22 +00:00
Fred Drake 52feb81932 support \e in \file and \filenq; this is useful for Windows paths 2004-02-09 20:58:08 +00:00
Fred Drake f0f6d12cd4 add \guilabel macro to mark labels that occur in user interfaces 2004-01-23 08:52:28 +00:00
Fred Drake 4f687b3051 add new reference macro: \seelink 2004-01-08 14:57:27 +00:00
Walter Dörwald f0dfc7ac5c Fix a bunch of typos in documentation, docstrings and comments.
(From SF patch #810751)
2003-10-20 14:01:56 +00:00
Fred Drake c8b08b446a add a note about how \ulink should be different than it actually is
for PDF generation
2003-09-06 04:19:43 +00:00
Fred Drake bd5fdd93a9 Make it easier to figure out the where a menuselection starts and ends
by controling the font.
2003-07-16 14:01:56 +00:00
Fred Drake 567332abc4 Start something that might make table notes easier to deal with,
eventually.
2002-12-30 20:51:27 +00:00
Fred Drake 2eba52fefb Thinking on comp.text.tex seems to be that it's better to override
\@makefntext than \@footnotetext, so we'll do that instead.
2002-11-04 16:29:31 +00:00
Fred Drake ff031cfdf4 Define abstract way to get the normal and smaller font sizes that work
even in the footnote context.
2002-10-31 21:04:34 +00:00
Fred Drake 699799e6f3 Add a couple of comments about the use of \normalsize and
\footnotesize.
2002-10-30 22:20:27 +00:00
Fred Drake b481286504 Add a comment showing how one of the macros should be used. 2002-08-02 18:30:22 +00:00
Fred Drake ad74b7d4b3 Abstract the creation of signature lines for callable things; the new
\py@sigline macro will wrap the argument list so it will not extend into
the right margin.
Substantially based on a contribution from Dave Cole.
This addresses one of the comments in SF bug #574742.
2002-07-02 20:32:50 +00:00
Fred Drake 34adb8a8ec Separate out a \cfuncline macro from the cfuncdesc environment.
This matches many other of the *desc environments, and is useful when
multiple functions share a description.
2002-04-15 20:48:40 +00:00
Fred Drake 01e94618f5 Additional support for describing C structure members. 2002-04-12 22:48:02 +00:00
Fred Drake 19f827e765 Add \csimplemacro to parallel the csimplemacrodesc environment.
Fix a typo in the comments for csimplemacrodesc.
2002-04-09 20:16:47 +00:00
Fred Drake 00f712ee24 Extend \verbatiminput so that the typeset version provides the same appearance
as a verbatim environment.  (The HTML version is already fine.)
2002-03-28 22:28:43 +00:00
Fred Drake 15fc72ce77 Make \url to force horizontal mode. 2002-03-26 19:14:41 +00:00
Fred Drake 0e4cd7f267 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not
change the installed version on either of the machines I use to format the
docs.  Instead, use a compatibility hack to support both versions.  This is
also better for external users of the Python styles.
2002-03-16 04:52:36 +00:00
Fred Drake 5381588073 Revise the markup related to the grammar productions to increase the
level of predictability.  This is not really "good" markup, but is arguably
better than we had before.
This closes SF bug #523117.
2002-03-15 23:21:37 +00:00
Fred Drake 6ca33771f8 Add a new environment for whole-paragraph (or longer) notes & warnings. 2001-12-14 22:50:06 +00:00
Fred Drake c82bd7281f Save a new version of the productionlist environment for safe-keeping; this
will be replaced shortly.  See the comments for more details.
2001-12-11 18:47:36 +00:00
Fred Drake 5ed35fd149 Add a new environment in the Python docs markup: seealso*. This is similar
to seealso, but does not add the "See also:" header or put the content in a
box in the HTML version.

Updated the description of \seeurl to better indicate when it should be used;
the old description was written before we had \seetitle.
2001-11-30 18:09:54 +00:00
Fred Drake 622087a3ed Fix stupid bug recently introduced for DVI version of the docs (used to
generate PostScript).
2001-11-02 20:53:19 +00:00
Fred Drake e59feb5edc Revise the PDF support in the LaTeX style sheet. This still isn't quite
right, but the tests for whether we are generating PDF are a bit more
readable, and some unnecessary indirection has been removed.
2001-10-29 21:02:28 +00:00
Fred Drake 92350b3a1f New markup: \note{...} and \warning{...} 2001-10-09 18:01:23 +00:00
Fred Drake 479384e1ff Move the styling for the HTML version of \mailheader into the CSS file.
In both the HTML and typeset versions of the documentation, add a colon
after the name of a mail header so that it is more easily distinguished
from other text.
2001-09-26 18:46:36 +00:00
Fred Drake 16bb41934c New \grammartoken markup, similar to \token but allowed everywhere. 2001-08-20 21:36:38 +00:00
Fred Drake 7eac0cb04c Define the \mailheader macro and document conventions for using it. 2001-08-03 18:36:17 +00:00
Fred Drake f269e59232 Define new markup for 5-column tables. 2001-07-17 23:05:57 +00:00
Fred Drake b4b64daa5e Add \ulink, grammar production markup. 2001-07-06 22:44:48 +00:00
Fred Drake 5445e5e305 \infinity,
\plusminus:  New macros to allow us to avoid math mode for these symbols.
2001-06-23 03:11:45 +00:00
Fred Drake c65218e1fd Add a little more support for describing version information. This
is not pretty, but does what is needed.
2001-06-20 21:17:09 +00:00
Fred Drake 06a01e84b9 Define a new environment, classdesc*, which can be used to document a
class without providing any information about the constructor.  This
should be used for classes which only exist to act as containers rather
than as factories for instances.
2001-05-11 01:00:30 +00:00
Fred Drake fdfb05bb0b \versionadded: Add support for including an explanatory note along with
the versioning information, similar to \versionchanged.
2001-04-18 03:08:54 +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