Commit graph

1205 commits

Author SHA1 Message Date
Fred Drake
0ee9f727c9 \withsubitem{}: New macro. Change indexsubitem temporarily for another
macro.  Intended usage:

		\withsubitem{(in module foo)}{\ttindex{myfunc()}}

	This allows indexing functions from other modules/class/whatnot
	without being dependent on the exact expansions of several macros
	internal to python.sty.  It's also easier to read in the source!

Some new "logical" macros that seem to be useful:

\regexp{}:  For regular expressions.  To make it easier to keep the appearance
	consistent.

\mimetype{}:  Don't use \code{}!

\envvar{}:  Environment variable.  This does some indexing as well.

\character{}:  Just a character we want to talk about in the text, but not
	a Python constant.
1998-03-12 06:41:40 +00:00
Fred Drake
6a1eefe535 Logical markup. 1998-03-12 06:04:53 +00:00
Fred Drake
a2e9818467 Logical markup.
Improve some index entries.
1998-03-12 05:54:02 +00:00
Fred Drake
c71585e069 Logical markup.
Markup consistency.

Removed incorrect \setindexsubitem{}.
1998-03-12 05:33:40 +00:00
Fred Drake
4912beb9d8 Add copyright statement.
Add section on using A4 paper, since that's a common request.
1998-03-11 17:07:35 +00:00
Fred Drake
664b36ff59 *Sigh*
Add a -q option for "quiet" operation.  Nothing gets out (not even stderr,
since that's tossed to stdout for capture in the .how file).  It's a good
idea to use -l to get the log in case there are problems.  Maybe this should
be the default and add a --verbose option to get the stdout?  There's way
too much junk output.
1998-03-11 15:41:21 +00:00
Fred Drake
dbc879e949 Allow the user to operate the script in debugging mode (-D), which just does
a "set -x".

Allow keeping a transcript, using -l, in $FILE.how.

Allow keeping of all the temp files created by the process, using -k.
1998-03-11 15:33:44 +00:00
Fred Drake
c9f2c14d49 Somewhat more direct way of locating the file, using __FILE__.
Leave find_my_file() around for now, even though we're not using it at the
moment.
1998-03-11 12:08:21 +00:00
Fred Drake
bc8ad5bdeb Replace lists of attributes for code and frame objects with a reference to the
Python Reference Manual.
1998-03-11 06:29:59 +00:00
Fred Drake
fdbd51db8b Logical markup. 1998-03-11 06:24:46 +00:00
Fred Drake
60ba44750f Logical markup. 1998-03-11 06:18:15 +00:00
Fred Drake
295eaa84b0 Logical markup.
Changed example to use "import posixfile" instead of "from posixfile import *"
since only one symbol was used.
1998-03-11 06:11:37 +00:00
Fred Drake
e42f595e5c Logical markup.
Made references to constants in other TERMIOS module explicit in termios
description.

Removed superfluous backslash from example.
1998-03-11 06:00:23 +00:00
Fred Drake
db9693ec97 Logical markup. 1998-03-11 05:50:42 +00:00
Fred Drake
75aae9ad89 Logical markup.
Added information on the exception attributes when exceptions are classes.
1998-03-11 05:29:58 +00:00
Fred Drake
e2e904f303 Script to format HOWTO documents. Currently only tested on the "Using
Kerberos from Python" HOWTO (this will change shortly, I hope).

This needs to be run from it's location in the Doc/tools directory, and
not via a symlink.  I'll try and fix this in the future.

The help message needs work.
1998-03-10 23:23:05 +00:00
Fred Drake
db34a1e2d8 Use the location of the initialization file to augment the style-specific
.perl file search path, rather than making assumptions about the current
directory.
1998-03-10 23:02:57 +00:00
Fred Drake
eff1f7622a clean_title(): Remove debugging prints. 1998-03-10 14:33:27 +00:00
Fred Drake
ac77b79df6 clean_title(): Clean a little more carefully. Still does funny things with
underscores.  Might this be a fundamental PDF limitation?  Hm, could
	still be a TeX thing.
1998-03-10 14:02:35 +00:00
Fred Drake
45e564dd78 In the source dist., don't include:
- the .cvsignore files; these are only useful in the CVS tree

	- ref/ref.pdf

	- ref/ref.ps

After compression, these last two account for about one-half MB, and half
the tarball.  They can be picked up from the appropriate format dist if
needed.
1998-03-10 14:00:55 +00:00
Fred Drake
b30d0164bf Logical markup. 1998-03-10 05:41:08 +00:00
Fred Drake
4ef3329259 Logical markup.
Correct misuse of indexsubutem.

Describe the Queue class using {classdesc}{Queue}, not {funcdesc}{__init__}.
1998-03-10 05:32:30 +00:00
Fred Drake
8aee0e0356 Add some more labels for logical addressing. 1998-03-10 05:21:39 +00:00
Fred Drake
d883ca1dcb Logical markup. 1998-03-10 05:20:33 +00:00
Fred Drake
193338afeb Logical markup.
Convert one bulleted list to a {tableii} environment; the other should
probably be converted, but I haven't decided to what.
1998-03-10 04:23:12 +00:00
Fred Drake
2cb1074937 Use a {datadesc} environment to describe errorcode. 1998-03-10 03:53:03 +00:00
Fred Drake
92f31f1260 Logical markup. 1998-03-10 03:38:31 +00:00
Fred Drake
a44d74086c Logical markup.
Use {funcdesc} and {excdesc} to describe the module, not just running text.
1998-03-10 03:36:00 +00:00
Fred Drake
c4f15af7de Logical markup. small nits. 1998-03-10 03:17:26 +00:00
Fred Drake
520f8bd9b7 Ok, remove dependency on the obsolete tools/modindex.py. 1998-03-09 16:43:54 +00:00
Fred Drake
97c73c83ed Remove \newif relating to index support; no longer needed. Index control
is now shared and located solely in python.sty.
1998-03-09 16:40:31 +00:00
Fred Drake
7d20ffe245 Adjust the index inclusion for the new index support. 1998-03-09 16:39:22 +00:00
Fred Drake
568113a75b Obsolete. 1998-03-09 16:38:32 +00:00
Fred Drake
8bc965785e Adjust index file resetting; just remove the files. The new index support
doesn't fail if the files don't exist.

Use makeindex for the module index.
1998-03-09 16:37:52 +00:00
Fred Drake
b390daf704 Adjust the index support a bit to make it easier to deal with module index.
Don't generate the mod???.idx file if it wasn't requested with the new command
\makemodindex.

Change the format of mod???.idx to match that of "normal" .idx files.  This
lets us use makeindex for it and not need a special script.
1998-03-09 16:35:36 +00:00
Fred Drake
8fcad7beb1 Don't generate a \label{} here. 1998-03-09 14:48:00 +00:00
Fred Drake
2eda4ca4df Markup adjustments. 1998-03-08 08:13:53 +00:00
Fred Drake
cd14a87c02 Mark the journal title. 1998-03-08 08:02:58 +00:00
Fred Drake
23bc85a8a6 Correct spelling of emdash. 1998-03-08 07:56:48 +00:00
Fred Drake
7ddd043191 Moved solitary "see also" paragraph into a {seealso} environment, and told
why the reader should see also.
1998-03-08 07:44:13 +00:00
Fred Drake
013ad9869e Cleaned up some remaining markup nits.
Andrew:  In description of (?iLmsx), you say it matches the empty string and
sets the corresponding flag.  Is this correct?  Or does it only set the flag?
1998-03-08 07:38:27 +00:00
Fred Drake
8fab8cf211 Logical markup. 1998-03-08 07:14:20 +00:00
Fred Drake
b991f8d2e0 Some logical markup. 1998-03-08 07:09:19 +00:00
Fred Drake
b55f9d3dfc Small nits.
Don't run into the right margin.
1998-03-08 07:03:27 +00:00
Fred Drake
cc444e39e5 Nits. 1998-03-08 06:47:24 +00:00
Fred Drake
bccc64020e Logical markup.
Spell emdash right.
1998-03-08 06:41:57 +00:00
Fred Drake
0c2af2bef6 Spell emdash with three hyphens.
Minor nits.
1998-03-08 06:28:00 +00:00
Fred Drake
266b4c1506 Logical markup.
Index entry.
1998-03-08 06:12:10 +00:00
Fred Drake
c07ae9f4d2 Some logical markup.
Combine function pairs:  add() and __add__() go together.  This way they
share a single description and use less space.
1998-03-08 05:56:15 +00:00
Fred Drake
0fd72ee369 Logical markup.
Don't prepend the module name when referring to functions or data in the same
module.

Correct the description of "modules".
1998-03-08 05:43:51 +00:00