Commit Graph

736 Commits

Author SHA1 Message Date
Fred Drake 8805354bbc Simplify how some options get propogated. 1998-04-24 21:57:12 +00:00
Barry Warsaw dc1c970b0f This script appears to no longer be in the toolchain for Python
documentation, so it has been moved to ../../Tools/scripts

Fred, please verify.
1998-04-23 22:57:16 +00:00
Fred Drake 476412a918 cleanup(): Get rid of module index turds. 1998-04-17 20:25:55 +00:00
Fred Drake 7984256f4d build_ps(): Fix flags to dvips.
build_html():  Deal with node2label.pl a little better.
1998-04-17 20:06:16 +00:00
Fred Drake 4f6d6e487c Fix things. Blame Andy Eskilsson <andy.eskilsson@telelogic.se>.
But I'm not giving this or the info files out until Andy (or anyone else)
agrees to take over the maintenance of this script!  Hah!
1998-04-17 15:28:09 +00:00
Fred Drake 12f842e33e Adjust to allow both general and module indexes.
PDF output properly supports the outline.
1998-04-17 02:52:12 +00:00
Fred Drake bf88c3830e Fix the broken PDF links, really this time!
Appending a junk char to the end doesn't quite do it, or doesn't seem to at
any rate.  Instead, pad the page numbers to always be 3 charaters wide, with
leading zeros.
1998-04-15 17:50:22 +00:00
Fred Drake a88d681255 Change the form of the name given to each page of the PDF from "page.%d" to
"page.%dx"; this works around an acroread bug that causes targets not to be
recognized if their name is a prefix of another target in the file.
1998-04-15 14:53:28 +00:00
Fred Drake e3ae5198a3 Update to use the new release number. Will generalize in the next round. 1998-04-13 21:55:56 +00:00
Fred Drake 2b8c95e4ed Minor housing cleaning in HTML that gets generated. 1998-04-11 16:26:02 +00:00
Fred Drake 058068d992 Nearly a complete re-write.
Basically, it now works and produces a nice-looking HTML index.

Shows some promise for extensibility, but still young.  Needs useful comments.
1998-04-08 23:12:51 +00:00
Fred Drake a8e262b0b2 Use the new index style when running makeindex. 1998-04-04 04:20:21 +00:00
Fred Drake ac8f91ada4 Added --split for AMK; control split level of the HTML output. Use --split 1
to create a single HTML file.

Added --help.
1998-04-02 15:37:13 +00:00
Fred Drake ec56109a0a First (rough) cut at HTML index generation in Python. Not very pretty, but
easier to work with than the Perl code.
1998-03-27 05:25:43 +00:00
Fred Drake 19e2ce58bf Add support for mapping internal labels used from the index. 1998-03-27 05:24:53 +00:00
Fred Drake f558e3188e Make $MYDIR absolute -- bug reported by AMK. 1998-03-24 17:48:20 +00:00
Fred Drake 2543769ca5 Use "/usr/bin/env perl" for the #! line, and change the -i option to:
use English;
	$INPLACE_EDIT = '';

to get the inplace-editing behavior.
1998-03-19 05:17:49 +00:00
Fred Drake 1125488b24 build_dvi(): Make sure we run latex enough times; this now matches the #
of times pdflatex would be run, which is correct.
1998-03-18 22:06:13 +00:00
Fred Drake e603cb1073 Revive newind.py. -sigh- 1998-03-16 16:15:49 +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 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 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 568113a75b Obsolete. 1998-03-09 16:38:32 +00:00
Fred Drake 8fcad7beb1 Don't generate a \label{} here. 1998-03-09 14:48:00 +00:00
Fred Drake 473a90e831 Allow the user to specify the "biggest" section type from the command line;
default is "chapter".  Use 'python toc2bkm.py -c section' to use with
Python HOWTO documents.
1998-03-07 15:34:50 +00:00
Fred Drake 361ee6582a Utility to help create outline information for PDF. 1998-03-06 21:29:00 +00:00
Fred Drake 2888bf6cb9 Build a tarball that extracts to Python-$VERSION/Doc/ instead of Doc/,
at Guido's suggestion.
1998-03-05 16:31:22 +00:00
Fred Drake cefcb33d4e Oops, remove some debugging prints. 1998-03-04 06:34:21 +00:00
Fred Drake b98cd39e20 changeit(): Added support for \deprecated{}.
Chunk.__repr__(), main():  Allow Chunk objects to get the buffer, to make the
representation contain text instead of a pair of indexes.  This makes debugging
a little easier.
1998-03-04 06:33:43 +00:00
Fred Drake fcf275e0be Script to create a source distribution. See comments at top. 1998-03-03 17:22:44 +00:00
Fred Drake 4f4e920889 Use a Python script to create "empty" indexes. This solves Guido's
corrupted file problem and avoids the shell escape interpretation
portability problem.  ;-(  See comments at top of newind.py for an
explanation.
1998-02-27 05:18:28 +00:00
Fred Drake e817930a7b Adjusted to work with the newer version of LaTeX2HTML as well. 1998-02-26 18:49:58 +00:00
Fred Drake 74a11e59a2 Do a little bit more work on a table-driven basis. A little cleanup.
Seems to work at the moment.
1998-02-26 05:52:37 +00:00
Fred Drake 9c7c6bec98 Clean up name->name conversion a little, *make sure it happens in all the
right places*!
1998-02-19 21:40:22 +00:00
Fred Drake 526ebb4d97 Work on a temporary file, not the input file. 1998-02-19 16:01:41 +00:00
Fred Drake ef058037a5 Support environments {fulllineitems} and {classdesc}, more of the new logical
markup.

The info generation now works, yet again.
1998-02-19 15:20:30 +00:00
Fred Drake c02fbe52b2 breakable_re: Fix the RE so that module definition entries don't prevent
combining.
1998-02-19 06:05:29 +00:00
Jeremy Hylton 9caa110141 assure a consistent assignment for nodes with multiple labels 1998-02-18 16:10:22 +00:00
Fred Drake 9acafa8bb5 Don't make backups.
Use "mv" instead of "ln -s" to install the new names.
1998-02-18 14:52:24 +00:00
Jeremy Hylton daa2d5d4ea Patch HREFs in html files, replacing nodeXXX.html with label.html. 1998-02-18 13:53:48 +00:00
Fred Drake a219e7976f main(): Include a \label{modindex} in the output so latex won't let us re-use
the name elsewhere.  This is useful for the logical filenames project,
	since the "modindex" label is hardcoded into .latex2html-init.
1998-02-17 23:13:19 +00:00
Fred Drake e8b46132e2 Massive changes. Fewer warnings from the Python Library Reference. Still
messy, but the thing seems to be working without bombing completely today.
Formatting lib.texi with TeX doesn't seem to do too badly, either!

Info formatting isn't quite there; that might just have to disappear this
time.
1998-02-17 05:54:46 +00:00
Fred Drake cffaebb621 parse_line(): Strip whitespace from the module name.
main():  Include a comma between the module name and page number, to make
	 the generated index more like the "standard" generated index.
1998-02-13 05:11:05 +00:00
Fred Drake a94d21f44e Minor performance nits. 1998-02-10 21:35:49 +00:00
Fred Drake dd244a0b9e Script to fix up the Library Reference index so it's less ugly. The docstring:
"""Combine similar index entries into an entry and subentries.

For example:

  \item {foobar} (in module flotz), 23
  \item {foobar} (in module whackit), 4323

becomes

  \item {foobar}
    \subitem in module flotz, 23
    \subitem in module whackit, 4323

Note that an item which matches the format of a collapsable item but which
isn't part of a group of similar items is not modified.
"""

This results in a much more readable index, with less repitition of text;
especially for common method names.
1998-02-09 22:17:52 +00:00
Fred Drake c1ce320a4f Script to convert module index data to module index. 1998-01-02 03:00:27 +00:00
Fred Drake 43c9350f7a Getting uglier. But it doesn't completely bomb except for some table stuff.
I'll get to it when I can.
1997-12-29 21:40:35 +00:00
Fred Drake a4541af0ba A bunch of minor stuff.
Lots of support for new macros defined in myformat.sty; including the new
indexing macros, seealso environment & friends, and the byte code instruction
support.
1997-12-29 17:19:22 +00:00
Fred Drake 6ccaaf1a08 Change name of temporary file to avoid possible filesystem issues; matches
similar renaming of the @buildno file elsewhere in the Python tree.
1997-12-29 16:58:46 +00:00
Fred Drake cb91e7bbd3 Added the "italic correction" command ("\/") to the list of ignored commands.
There is at least one of there in the library reference, and this reduces
the warning count.  We *do* know what to do with it!
1997-11-25 04:06:21 +00:00
Guido van Rossum 6cb2ac226e A nicety (author lost). 1997-06-02 17:57:10 +00:00
Fred Drake 4b3f0312c9 (lib<all sorts of stuff>.tex):
Merged in many typo corrections and fixes to support GNU info
	processing; submitted by Tamito Kajiyama.
1996-12-13 22:04:31 +00:00
Fred Drake b33021b572 (fix_libaux.sed): Hackish little sed script to modify lib.aux to get section
numbers right for latex2html for section titles which include
	"\sectcode{__.*__}" in the name.  Perhaps less general than it should
	be, but sufficient.
1996-11-11 20:49:27 +00:00
Fred Drake abcb38250b (texi2html.py): Minor improvement to HTML 3.0 output for code examples. 1996-10-25 22:13:59 +00:00
Fred Drake 893e5e0a15 (partparse.py): Fix nasty bug where \e got translated to @e only within
the optional arg of an \item[].
1996-10-25 22:13:10 +00:00
Fred Drake acc8754031 (partparse.py): Small change by Sjoerd to improve handle of X11 extension
documentation.
1996-10-14 16:20:42 +00:00
Fred Drake 22f7f9e671 (texi2html.py): Added CLASS=Navigation attribute to DIV around top/bottom
navigation links for HTML 3 version.

	Forced a blank line above the footnotes separator for HTML 2; at
	least one page did not get this spaced correctly.
1996-10-11 16:54:00 +00:00
Fred Drake 11b6d24da0 (partparse.py): Small fix to do_datadesc(): in some odd cases the name of
data item was omitted, which also affected the indentation of the
	description.
1996-10-10 20:09:56 +00:00
Fred Drake 0282726643 (texi2html.py): Tightened the generated HTML slightly. Added -p option to
print section titles even when the debugging output is not enabled.
	Added -3 option to generate HTML 3.0 constructs where meaningful.

	Removed repititive garbage generation:  the old version added simple
	descriptive comments after every datadesc/funcdesc/*desc entry:

	function(args) -- function of module xxxx
	    Description....

	These comments are no longer generated:

	function(args)
	    Description....
1996-10-09 19:05:12 +00:00
Fred Drake 7edd8d3c58 (partparse.py): Rationalize some behavior around unexpected conditions. 1996-10-09 16:11:26 +00:00
Fred Drake a39a25e5ec (texi2html.py): Use "if __name__ == '__main__':" test. Adjust indentation
to 4 spaces per level (no longer 8).

(Makefile):  Use .pyc versions of partparse.py and texi2html.py to generate
	converted documentation formats.  This reduces the startup costs;
	probably doesn't affect anyone but me in reality, but helps when
	working on the docs.
1996-09-13 14:44:34 +00:00
Guido van Rossum 36f219dff8 More performance and layout improvements by Fred 1996-09-11 21:30:40 +00:00
Guido van Rossum 5f18d6c7a0 Reformatted with 4 spaces indent.
Got rid of most redundant \ continuation signs.
1996-09-10 22:34:20 +00:00
Guido van Rossum 49604d3182 20% speedup by Fred 1996-09-10 22:19:51 +00:00
Guido van Rossum 29901ff528 Some improvements by Fred Drake. 1996-08-09 21:46:34 +00:00
Guido van Rossum 06f4289d3f many fixes by anonymous contributor 1995-08-28 03:01:00 +00:00
Guido van Rossum a12bbff857 mods by Gregor Schmid -- very nice! 1995-05-03 14:17:36 +00:00
Guido van Rossum 557ed94ebb don't print PLAINTEXT = ... 1995-03-28 13:33:45 +00:00
Guido van Rossum 7760cdea81 recognize more latex commands; add obindex 1995-03-17 16:03:11 +00:00
Guido van Rossum b819bdfe83 handle a few new things 1995-03-15 11:26:26 +00:00
Guido van Rossum 26a9d37e5c new, from ../Demo/www 1995-03-15 11:26:05 +00:00
Sjoerd Mullender 1cfb6b8992 Can't remember the reason for the change, but it was necessary. :-) 1994-12-14 15:28:22 +00:00
Guido van Rossum 16d6e7109d Lots of small corrections by Andrew Kuchling (plus all new rotor docs) 1994-08-08 12:30:22 +00:00
Guido van Rossum 6938f06047 Merge alpha100 branch back to main trunk 1994-08-01 12:22:53 +00:00
Guido van Rossum ab3a2504b9 libsocket.tex: send[to] returns nbytes.
libstring.tex: added count().
ref2.tex: new keywords; moved keyword printing program to keywords.py.
1994-08-01 12:18:36 +00:00
Guido van Rossum c5c67bc367 At release 1.0.1. Scripts, Makefile, README: cosmetic changes and
streamlined procedure; tut.tex: fixes by Tim Peters; libposix.tex:
added posix.fdopen; ext.tex: typos
1994-02-15 15:59:23 +00:00
Guido van Rossum 36b4807621 A small but essential file... 1994-01-02 01:22:36 +00:00
Guido van Rossum 6f0132f490 * text2latex.py: call main() instead of always processing ext.tex.
* Makefile: added 'ext' to 'all' target
* ext.tex: more changes towards a readable text
* lib4.tex (posix): added set{uid,gid}
* lib2.tex (array): restored doc for typecode and itemsize (which were
  there but not visible for dir())
1993-11-19 13:13:22 +00:00
Guido van Rossum db65a6ce55 * ext.tex: did most of the tedious changes from plain ASCII text to LaTeX.
* text2latex.py: automatically put function names in \code{}.
* lib.tex, ref.tex, ext.tex, qua.tex, tut.tex: use new P.O.Box number in
  address.
1993-11-05 17:11:16 +00:00
Guido van Rossum 7a2dba2a00 * ext.tex: documentation for extending, reference counts, and embedding
(formerly ../misc/{EXTENDING,REFCNT,EMBEDDING}).  Also affects Makefile.
* text2latex.py: script to do part of the conversion from an plain ASCI
  text file (in my particular style) to LaTeX.
  (Chapter/section/subsection headers, and verbatim sections.)
* partparse.py, texipre.dat, fix.el, Makefile: Minor cleanup of latex ->
  info conversion process (at least it works again, and with less
  debugging output).  Removed fix.sh.
* lib1.tex (section{Built-in Functions}): adapt description of str() and
  repr() to new situation.
* lib3.tex (Module os): added exec*() variants.
* lib3.tex (Module posix): added execve().
* lib2.tex (Module array): documented reality; remove typecode and
itemsize, add byteswap, rename read/write to fromfile/tofile, and
re-alphabetized.
* lib1.tex (Built-in Functions): renamed bagof() to filter().
1993-11-05 14:45:11 +00:00
Guido van Rossum 23301a9467 * lib1.tex: documented dict.items() and dict.values()
* ref3.tex: documented new __init__ and __del__ special methods of
  class instances.
1993-05-24 14:19:37 +00:00
Guido van Rossum 3ad7fc70cc Documented marshal.{dumps,loads} and sys.builtin_module_names. 1993-01-22 15:48:14 +00:00
Guido van Rossum 95cd2ef162 Incorporated Jan-Hein's changes and texinfo conversion. 1992-12-08 14:37:55 +00:00