mirrors/cpython
mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-12-01 11:15:56 +01:00
Code Issues Releases Activity
27,457 Commits 6 Branches 593 Tags 3.3 GiB
e960e22579
Commit Graph

101 Commits

Author SHA1 Message Date
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
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