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
0aa811c527
Use the \note and \warning macros where appropriate.
2001-10-20 04:24:09 +00:00
77165d039f
Bump release information.
2001-10-18 18:41:12 +00:00
92350b3a1f
New markup: \note{...} and \warning{...}
2001-10-09 18:01:23 +00:00
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
56dd35bd44
Bump version number.
2001-09-21 21:18:16 +00:00
7feae2d28c
Bump version number.
2001-09-06 19:02:57 +00:00
16bb41934c
New \grammartoken markup, similar to \token but allowed everywhere.
2001-08-20 21:36:38 +00:00
8a7b59e7b4
Added this LaTeX style file to the package since not all LaTeX installations
...
have it, especially on non-Unix platforms. (MikTeX in particular does not
have it.)
This is part of the response to SF patch #429611 .
2001-08-10 19:47:41 +00:00
7eac0cb04c
Define the \mailheader macro and document conventions for using it.
2001-08-03 18:36:17 +00:00
413bfb766e
2.2a1 is out; look to the future.
2001-07-18 21:06:06 +00:00
0068e9c1eb
Mirror Guido's latest changes to the license file.
2001-07-17 23:08:24 +00:00
f269e59232
Define new markup for 5-column tables.
2001-07-17 23:05:57 +00:00
63d1d264d1
Update the release information.
2001-07-17 16:28:50 +00:00
6e5e1d924c
Minor change to match the style guide.
2001-07-14 02:12:27 +00:00
b4b64daa5e
Add \ulink, grammar production markup.
2001-07-06 22:44:48 +00:00
5445e5e305
\infinity,
...
\plusminus: New macros to allow us to avoid math mode for these symbols.
2001-06-23 03:11:45 +00:00
1bf198e946
Remove an extra tab character.
2001-06-22 18:36:07 +00:00
852f7951a2
Separate the copyright statements and license text; include some new
...
comments regarding the history of Python licensing from Guido.
2001-06-20 21:34:35 +00:00
f911a84d5a
Separate the version number and release status into two separate values.
2001-06-20 21:33:13 +00:00
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
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
635a7cfcbb
Sync version number with the current CVS version.
...
(Note that the docs are also being maintained on the 2.1.1 maintenance
branch, so users interested only in corrections and clarifications
can get that.)
2001-04-18 05:02:01 +00:00
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
3fee30407e
Bump version number and set date.
2001-04-14 18:36:03 +00:00
c790e08ac1
Use "2.1c1" since that is what Guido used for the Python version number.
2001-04-12 04:34:26 +00:00
c5287ac66a
Bump version numbers for upcoming release candidate.
2001-04-10 20:19:25 +00:00
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
697c9c9c71
In the typeset versions, the legal notices had grown past the one-page
...
size. This constrains them to fit in one page again.
2001-04-10 05:26:29 +00:00
6909642d38
Bump the version number.
2001-03-22 17:01:43 +00:00
15e07f4442
Update to the current state of the universe.
2001-03-22 17:00:05 +00:00
ab357ecf7f
Label classes and exceptions explicitly in the documentation (for their
...
*desc environments).
2001-03-02 18:57:05 +00:00
8bcc4e8446
Commit this so CVS doesn't keep noticing the next version number.
2001-02-14 20:53:07 +00:00
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
0a8690a0ad
Make "PythonLabs" bold.
2001-01-22 17:48:23 +00:00
c49480ed51
Miscellaneous updates.
2001-01-09 21:40:52 +00:00
2ed27d3189
Note that readframes() returns data in linear format, even if the original
...
is encoded in u-LAW format. Based on suggestion from Anthony Baxter
<anthony_baxter@users.sourceforge.net>.
This closes bug #122273 .
2000-11-17 19:05:12 +00:00
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
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
f61eac425a
Remove second horizontal line below table headers; it is just too
...
distracting.
2000-10-24 02:18:30 +00:00
9d62943f24
Center the top line of the license page, to make it look just a little bit
...
cleaner.
2000-10-14 04:07:49 +00:00
91eb3e8558
Update the release number and date.
2000-10-13 15:35:27 +00:00
559b5c8892
Update for next planned release.
2000-10-05 03:24:00 +00:00
a9dd2eeb51
Update versioning for the next Python release.
2000-09-22 16:20:23 +00:00
cb0a0b3e80
New text about how to report bugs in Python and the documentation.
2000-09-21 21:32:14 +00:00
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
2964268db5
Allow the LaTeX markup descriptions to use the \moreargs and \unspecified
...
macros in the argument list position.
2000-09-21 15:53:54 +00:00
bd2d4f1252
Use the \setshortversion macro to specify the abbreviated version number.
...
This partially addresses SourceForge bug #114318 .
Fix the release number -- this is supposed to be the *Python* release,
not the documentation release! The later is given by the combination of
the Python release number and the date. Add a comment so I can keep it
straight.
2000-09-14 20:28:26 +00:00
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
e92cdba105
Documentation is good. Let's release more.
2000-09-12 21:08:55 +00:00
48449985f4
\seetitle: New macro for building reference list content.
2000-09-12 17:52:33 +00:00
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
5cd0cefbd2
Remove the specific date -- back in development mode.
2000-09-07 18:56:29 +00:00
8bdf0bf705
Fix PDF generation.
...
The \\ introduced in the \author in boilerplate.tex broke the PDF
generation because line breaks are not allowed in the "Document Info"
metadata stored in the PDF file. This changes the line break to
a ", " (comma-space) in that context.
2000-09-05 15:19:56 +00:00
82de71dae8
Minor nit to make this work a little better with the PDF generation fix.
...
This does not change the HTML or PostScript output.
2000-09-05 15:11:56 +00:00
c28425f4c6
Update license according to the LICENSE file in the source tree.
2000-09-05 04:32:26 +00:00
05e4ef01a2
Set the date.
2000-09-05 03:13:38 +00:00
de9fec5f99
\citetitle: Format the title, not the optional URL!
2000-08-17 04:25:59 +00:00
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
885082ca67
Update, 'cause Guido said it should be this way.
2000-07-31 14:31:28 +00:00
1cd3c14034
The new copyright / license.
2000-07-01 01:41:55 +00:00
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
aad1d4b8f2
Update the release number & date, Guido's employer.
2000-06-30 15:35:16 +00:00
51313f164c
Define \seeurl in the seealso environment. Two parameters: url, why.
2000-05-09 16:18:44 +00:00
a6e8339e61
\versionchanged: Added optional parameter for explanation of change.
2000-05-02 17:28:36 +00:00
64b72b6f4f
Define \seerfc within the seealso environment.
2000-04-26 18:13:58 +00:00
c402fa122f
Dropped '\tilde' and '\bslash' definitions.
2000-04-19 22:40:34 +00:00
95da443447
Removed '\package' definition.
2000-04-19 22:36:33 +00:00
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
493624941a
\longprogramopt: New macro.
2000-04-11 18:47:59 +00:00
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
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
ba82878a3b
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
89af0776cd
This branch is for 1.6 & forward.
2000-02-22 18:20:03 +00:00
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
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
919e74ce88
Darn! Forgot to re-target.
1999-07-02 15:27:14 +00:00
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
66823029a4
\declaremodule: Typo.
1999-05-17 14:57:26 +00:00
5bc8d99bce
\declaremodule: Make this more robust. Only attempt to add an index
...
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.
1999-05-17 14:47:10 +00:00
84bd6f3b18
Change the look of \seemodule output to fit in better.
1999-05-11 15:42:51 +00:00
250ba78565
Let's try again: new assertion.
1999-04-28 16:57:01 +00:00
0a0fd595b3
\filenq: Like \file, but don't use single-quotes; this looks better
...
in tables.
1999-04-28 14:59:44 +00:00
d960dc81b5
Fix square brackets around optional parameters to macros.
1999-04-23 14:44:53 +00:00
7bf96ca32d
Make an assertion.
1999-04-22 14:16:59 +00:00
30a535c0f7
Added support for adding environment/macro parameters more cleanly:
...
\op adds an optional parameter, and \p adds a required parameter.
These are only defined in the context of the parameter list parameter
of the envdesc and macrodesc environments.
1999-04-22 13:03:49 +00:00
cc10e0469a
Just in case a copy of the documentation gets released somehow...
1999-04-13 21:22:46 +00:00
9b8afdee44
Use more recent option to \pdfdest to not change the zoom factor.
...
This is in response to a comment from Wes Rishel <wes@rishel.com>.
1999-03-24 14:16:17 +00:00
9466b9a10d
Add some (commented out) macros to change the page size to the size of
...
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.
1999-03-18 16:18:27 +00:00
1d8f07acbd
Markup for documenting LaTeX macros and environments.
1999-03-16 16:08:26 +00:00
0c275fa856
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
69d49d6378
Set target.
1999-02-15 15:02:21 +00:00
2116d983bf
Make \versionadded and \versionchanged less prominant -- neither bold
...
nor a separate paragraph.
1999-02-02 18:02:48 +00:00
aa2aea0e79
\py@linkToName: New macro to consolidate support for most internal
...
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.
1999-01-27 17:37:36 +00:00
9f253dc3ff
\py@modindex: Format the index entry for the module index more like
...
that used in the "normal" index. No visual difference, but
more easily processed by helper scripts.
1999-01-26 19:23:09 +00:00
da94374a86
\seemodule: Fix so that each \seemodule entry gets its own paragraph,
...
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.
1999-01-13 17:09:06 +00:00
dd7610cac9
Bump the date. Seems like fun. ;-)
1999-01-12 19:51:03 +00:00
b75d021081
Typo: "TWELV" --> "TWELVE"
...
Added note at top, since LaTeX style writers like to force name
changes when someone else makes a change to the style. I'm sending a
note to the author reporting the error and asking for an updated
version.
This cannot be distributed in this form. This will be resolved when I
get a response from Ulf Lindgren.
Typo reported by rwolff@noao.edu (Richard Wolff).
1999-01-04 16:15:02 +00:00
ae48aabb10
Update the date.
1998-12-22 18:27:22 +00:00
fa1cceb91f
Make \var work correctly in math mode.
1998-11-30 14:42:59 +00:00
Fred Drake
Greg Ward