Fred Drake
498cb15306
Jon Nelson <jnelson@users.sourceforge.net>:
...
Make the documentation tools work with Python 1.5.2.
[Slightly modified from submitted patch. --FLD]
This closes SF bug #132005 .
2001-02-12 19:12:55 +00:00
Fred Drake
b258bedb13
Jon Nelson <jnelson@users.sourceforge.net>:
...
Make the documentation tools compatibile with Python 2.0.
2001-02-12 15:30:22 +00:00
Fred Drake
4e3f2752c5
Improve diagnostic output when an external command returns a non-zero exit
...
code, showing the transcript for that command.
This closes SF bug #129740 .
2001-02-04 15:20:26 +00:00
Fred Drake
24da47708d
Do not pass names of individual files to shutil.rmtree(); use os.unlink()
...
for that.
2001-02-02 15:48:00 +00:00
Fred Drake
5599441bbf
Make HTML the default output format, since that is what people actually
...
want most of the time.
2001-01-30 22:30:01 +00:00
Fred Drake
bc3974c03b
When generating the source package, copy in the LICENSE file from the main
...
source directory.
2001-01-22 21:34:20 +00:00
Fred Drake
42181dba8e
Added a --global-module-index option to specify a (possibly relative) URL
...
to the Global Module Index for a set of documents. This is used to include
a reference to the global index from the per-document module indexes, so
that it is just a little easier to find.
(Someone suggested this, but I do not remember who. Please let me know if
it was you -- thanks!)
2001-01-09 22:02:10 +00:00
Fred Drake
827bb9fb3c
Adjust to allow an explanation of the changes to be included in the
...
notification message.
2000-11-30 07:38:59 +00:00
Fred Drake
0a0ef8696b
Use a subclass of buildindex.Node to clean up the HTML and get the
...
ordering fixed up (this makes sure that "xml.dom" comes before
"xml.dom.minidom" in the Module Index, which was not true before because
some HTML cruft crept into the data structures).
2000-11-28 16:20:50 +00:00
Fred Drake
fed0d09075
Conversion.write_ordinal(): Not used, remove it.
2000-11-22 17:59:32 +00:00
Fred Drake
691a5a7c09
Convert the LaTeX "tie" (~) to a simple space.
...
Add support for some combining characters.
Remove unnecessary imports and dependencies on PyXML and esistools.
2000-11-22 17:56:43 +00:00
Fred Drake
382a75d0e9
Update to reflect the process changes.
...
Remove the SGML aspects; there's too much XML momentum to worry about
the SGML flavor at this point.
2000-11-22 16:58:25 +00:00
Fred Drake
97be740cd8
Update the rules to separate the two phases for the ESIS generation,
...
entirely so that debugging can be performed independently.
2000-11-22 16:54:20 +00:00
Fred Drake
d397f236d5
Add support for (relatively) recent additions and changes to python.sty,
...
and one more standard LaTeX macro.
2000-11-22 16:45:19 +00:00
Fred Drake
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
Fred Drake
9dce7b3737
Make sure we clean up the index data each time it is written by LaTeX.
2000-11-03 02:57:31 +00:00
Fred Drake
d34cfcb4c7
Revise the message to be a little nicer.
...
Have the mail sent to the python-dev and Doc-SIG lists.
2000-10-29 13:21:45 +00:00
Fred Drake
7ceab739d0
Make this actually work now that the tool is checked in here instead of
...
just sitting around in my working directory.
2000-10-24 19:59:55 +00:00
Fred Drake
692565c9e9
Helper scripts used in published the "development" snapshots of the
...
Python documentation.
2000-10-19 05:54:51 +00:00
Fred Drake
77b76b6db6
Substantially revise to handle the fact that Python CVS is no longer in a
...
file-system accessible repository. Add a little bit of smarts to convert
the cvsroot to an anonymous cvsroot the real one requires an authenticated
login to SourceForge; this avoids the SSH startup delay when doing the
checkout or export to get a fresh copy of the tree.
2000-10-10 19:35:40 +00:00
Fred Drake
77878413ba
Hush the nanny.
2000-10-07 12:50:05 +00:00
Fred Drake
476491396e
Use the cvsinfo module instead of a module stuff off in my personal
...
collection.
2000-10-06 16:37:47 +00:00
Fred Drake
72fbd8264c
Support module to help work with checked-out CVS trees.
2000-10-06 16:36:48 +00:00
Fred Drake
85788edca4
Better add at least a short docstring to the module!
2000-10-05 05:20:55 +00:00
Fred Drake
f23431da11
New script to convert the ACKS file to a nicely formatted HTML file.
...
Uses the new support module.
2000-10-05 05:15:29 +00:00
Fred Drake
01a110be57
Use the new support module instead of including all the getopt
...
processing and style information directly.
2000-10-05 05:14:26 +00:00
Fred Drake
ca2b2e04e1
Factor out some of the presentation and shared code from mkmodindex and
...
a mkackshtml (not yet checked in).
2000-10-05 05:11:57 +00:00
Fred Drake
63eb6300a9
Remove styling information that conflicts with or duplicates the stylesheet;
...
different browsers resolve the conflicts differently, and the "proper"
resolution is not what we actually want.
Reported by Peter Funk <pf@artcom-gmbh.de>.
2000-10-04 13:39:24 +00:00
Fred Drake
1654b43ef7
Preliminary tool to troll through the CVS logs and LaTeX sources for
...
the names of people that should be in the ACKS file.
This relies on some personal code that is not yet available, but should
be by the time we release 2.0c1.
2000-10-03 22:10:25 +00:00
Fred Drake
3764b6b67e
Fix the way we found relevant cfuncdesc lines; PREFIX was not a regular
...
expression!
2000-09-22 17:55:32 +00:00
Fred Drake
df84facf0d
.use_latex(): Make this a little smarter so that it only runs pdflatex
...
once if all the temporary files are available from building
a DVI file. This can avoid two runs of pdflatex.
2000-09-20 05:49:09 +00:00
Fred Drake
f3d41272c6
Before running LaTeX2HTML, remove all the HTML files from the output
...
directory. This avoids acretion of HTML from previous runs which may
have a new name; this would have avoided a lot of the packaging problems
related to changing labels from the old distutils documentation.
2000-09-14 22:25:47 +00:00
Fred Drake
0b25053ca0
Make this script handle PyVarObject* functions as well as PyObject*
...
functions.
2000-09-12 20:47:29 +00:00
Fred Drake
ae3a15c396
Make the HTML more XHTML-friendly.
...
Small nits in the layout of the generated markup.
2000-09-07 20:07:41 +00:00
Fred Drake
239e1d5e50
Fix mkhowto so that the bookmarks for the PDF work for both "howto" and
...
"manual" class documents.
2000-09-05 21:45:11 +00:00
Fred Drake
dfa539d770
Add --up-link and --up-title parameters to allow linking the top level
...
of the generated document to an external index. These correspond to the
-up_url and -up_title parameters of LaTeX2HTML.
2000-08-31 06:58:34 +00:00
Fred Drake
0154fea5f4
Remove obsolete scripts.
2000-08-31 06:15:30 +00:00
Fred Drake
8bc627a402
Add --l2h-init option, which can augment the standard LaTeX2HTML
...
initialization with additional Perl files. This can be given more
than once.
2000-08-31 06:14:38 +00:00
Fred Drake
fcb8725de5
Add a --style option to allow specifying an alternate CSS style sheet for
...
HTML generation; the machinery was there but no option to set it was
defined.
Simplify some of the path-math since we can assume a recent version of
Python.
2000-08-29 18:15:05 +00:00
Fred Drake
1915754ec9
Small changes to reflect changes in LaTeX2HTML support for newer versions
...
of LaTeX2HTML.
2000-07-31 17:47:49 +00:00
Fred Drake
498c18f4d0
Only use one initialization file for LaTeX2HTML; more recent versions only
...
use the last one specified on the command line instead of all of them.
Smaller changes to reflect updated support.
2000-07-24 23:03:32 +00:00
Fred Drake
d95f4e1a0d
Martin von Loewis <loewis@informatik.hu-berlin.de>:
...
Correct typo that caused a well-formedness failure.
2000-07-01 06:26:44 +00:00
Fred Drake
cc7371c437
Removed --l2h-config option; it introduced unnecessary complexity and
...
is not needed anywhere.
2000-06-29 23:01:40 +00:00
Guido van Rossum
51060be2f8
Remove unused "import curses".
2000-05-24 14:33:26 +00:00
Greg Ward
3abb104356
Added the Distutils manuals.
2000-04-28 17:05:41 +00:00
Fred Drake
5e872de6c7
If the refcount field is "null", that's ok; the value will be None.
2000-04-10 18:24:26 +00:00
Fred Drake
729eca1b9d
For functions which return a PyObject* but use "null" for the
...
reference count field, state that the return value is always NULL.
(Useful for some PyErr_*() flavors.)
2000-04-10 18:23:47 +00:00
Fred Drake
ba82878a3b
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
Fred Drake
9a257b4fd4
Added --numeric option, similar to mkhtml.sh.
2000-03-31 20:27:36 +00:00
Fred Drake
dee86c644e
Script to annotate api.tex with reference count information.
2000-03-15 14:57:59 +00:00
Fred Drake
c29e41df44
Script to help locate markup that LaTeX2HTML has a problem with.
2000-02-21 17:20:16 +00:00
Fred Drake
ecb84f8e75
Don't insert extra indentation before <title> elements.
2000-01-20 22:51:14 +00:00
Fred Drake
645af9fedd
rewrite_descriptor(): Fixup conversion of arguments (simpler).
...
join_adjacent_elements(): Hack to merge adjacent instances of
<option>; the source \programopt with GNU-style long options
created problems with LaTeX2HTML; this removes the evil
workaround, which should never be necessary from structured
documents(!).
1999-11-23 21:52:03 +00:00
Fred Drake
8a3b4495df
Don't rename \var to <varname>; DocBook is too verbose here.
...
Do adopt DocBook's <command>, <option>, <envar> names for \program,
\programopt, \envvar.
Add \filenq --> <filename quote="no"> (it has to go somewhere, at
least for now).
1999-11-23 21:48:41 +00:00
Fred Drake
91f31eab1c
Added citetitle and programopt.
...
Made var get renamed to varname (more like DocBook).
Other names should probably be changed as well; still waiting for the
DocBook book to arrive.
1999-11-09 19:33:24 +00:00
Fred Drake
5bd608d46e
Change the suggestions pointer at the bottom of generated HTML pages.
1999-10-29 20:51:43 +00:00
Fred Drake
d6512808f0
Module/script to parse the reference count data file and make the
...
information accessible to Python.
When run as a script, just dumps the information back out in the data
format, with functions in sorted order and a blank line between
different functions.
Still need to apply the information somehow.
1999-10-20 21:50:31 +00:00
Fred Drake
cf1b06ec47
Added --about option to specify the file to load "About this
...
document..." text from, defaulting to ../html/about.dat.
1999-09-23 16:55:09 +00:00
Fred Drake
52ea0ce977
Added --image-type option to allow use of either GIF or PNG images.
...
Job.warning(): New method; use this instead of writing to sys.stderr
directly. Ensures warnings are also sent to the log
file.
Job.log(): New method; write a message to the log file. Use from
.message() and .warning().
1999-09-22 19:55:35 +00:00
Fred Drake
0ee4891c82
Update the instructions slightly.
...
Add a new section describing what each of the tools does, in general
terms.
1999-08-26 18:08:13 +00:00
Fred Drake
4f0279f439
Removed; no longer needed now that the other tools can handle entity
...
references directly.
1999-08-26 18:05:23 +00:00
Fred Drake
abb158f56b
feed(): Added support for ESIS '&' lines.
1999-08-26 18:04:32 +00:00
Fred Drake
1f33292542
Remove use of fixgenents.sh; no longer needed.
1999-08-26 17:57:18 +00:00
Fred Drake
3cf4eb4e3d
Specify: \geq --> ≥
...
\leq --> ≤
\LaTeX --> LaTeX (just text)
\TeX --> TeX (just text)
1999-08-26 17:56:47 +00:00
Fred Drake
f6199edcd3
Conversion.subconvert(): Added support for "entityref" parameters
...
(must be named in the conversion spec.).
TableParser.start_entityref(): New method. Use to support creating
entity references via the conversion specification.
1999-08-26 17:54:16 +00:00
Fred Drake
a20581c1e5
write_esis(): Added support for ENTITY_REFERENCE nodes.
1999-08-26 17:51:56 +00:00
Fred Drake
53eae8e81b
convert(): Add support for ESIS '&' lines, and make sure we don't
...
silently ignore unrecognized lines.
1999-08-26 17:50:26 +00:00
Fred Drake
abf8a1daa8
rewrite_descriptor(): Fix bug that dropped the first TEXT node from
...
<description> elements. Add another sanity
check to make sure a special case only becomes
involved for <opcodedesc> and <opcodedescni>
elements.
fixup_paras_helper(): Clean up control flow.
Everywhere that checks node.nodeType==ELEMENT and node.tagName now
just check node.nodeName (nodeName is guaranteed for all node types
and will be special values that don't conflict with GIs for
non-ELEMENT nodes). Simplifies a number of tests and improves
readability in a lot of places.
1999-08-20 14:28:29 +00:00
Fred Drake
46ab6dfa89
Re-write in Python for portability. About 30% slower, but who cares?!
1999-08-03 17:54:39 +00:00
Fred Drake
82ebc27357
remap_element_names(): Only used for things that the new conversion
...
engine in latex2esis.py can do, so discard it.
paragraph detection & markup: Handle some of the list-like
environments properly, picking up paragraphs inside
list items. (Only changed a few element-sets used for
recognition.)
fixup_refmodindexes_chunk(): Use the right attribute to determine the
module a <ref*modindex/> element is referring to.
convert(): Don't call remap_element_names(); it was removed.
1999-08-03 15:32:48 +00:00
Fred Drake
2f6ec9ca81
The new conversion engine supports more of the table re-writing than
...
the old one, so use it.
1999-08-03 15:27:37 +00:00
Fred Drake
9ff3a6a6e7
Remove obsolete version of script.
1999-08-02 20:19:42 +00:00
Fred Drake
9f2b42080a
Re-implementation of mktarball.sh as a more portable Python script;
...
with a more descriptive name.
Allow creation of multiple archive formats with a single pass; useful
in this case since it uses a fresh export/checkout from CVS to ensure
that the tree is "clean" (no build turds, saved files, &c). Use --all
to create all supported formats.
1999-08-02 20:19:17 +00:00
Fred Drake
080c1b5af6
bwrite(), ewrite(): Helpers for diagnostic output; essentially the
...
same as sys.stderr.write(), but bwrite() will make it
bold if stderr is a tty (for visibility).
Use these everywhere instead of accessing
sys.stderr.write() directly.
find_all_child_elements(): Find all elements by type name that are
immediate children of another.
cleanup_synopses(): Receive both the document and fragment objects as
parameters; if only the document is passed, synopsis
information is never found since it's in the fragment!
build_para(): Add a chunk of code to ensure that a newline always
follows the </para> end-tag. Not really important, but
makes presentation consistent for authoring/
maintenance.
fixup_bifuncindexes_chunk(): Use find_all_child_elements() instead of
find_all_elements() so we don't work with too many
levels at once; that could cause DOM exceptions with
the <elem>.removeChild() method.
1999-08-02 14:46:15 +00:00
Fred Drake
4fbdf9779c
Mostly minor changes.
...
Removed some obsolete commented-out code.
Merged BaseConversion into Conversion since there's only one
conversion process now.
Remove push/pop of output stream; it's no longer needed.
1999-08-02 14:35:25 +00:00
Fred Drake
d158b85896
This doesn't need to do nearly as much for the new conversion, so
...
simplify.
1999-08-02 14:32:46 +00:00
Fred Drake
031e222499
A few small improvements to the conversion.
1999-08-02 14:32:11 +00:00
Fred Drake
eac8abee4e
Ripped out the old conversion.
1999-07-29 22:42:27 +00:00
Fred Drake
865e9ff98e
Added a few more passes through the document fragment. Not actually
...
very interesting.
1999-07-29 22:23:19 +00:00
Fred Drake
96e4a06fa6
Massive changes.
...
Separate the Conversion class into a base and a subclass; the subclass
is pretty minimal but the separation is useful for....
NewConversion: New class that implements a somewhat different
approach to the conversion. This uses a table of
instances (rather than tuples) that have more
information than the tuples used for the older
conversion procedure. This allows a lot more control
over the conversion, and it seems to be pretty
stable.
TableEntry,
Parameter: New classes that are used to build the conversion
specification used by NewConversion.
TableParser: xmllib.XMLParser subclass that builds a conversion
specification from an XML document.
load_table(): Convenience function that loads a table from a file.
main(): Added flags --new and --old; these select which conversion is
used. The default is --new.
Several fixes have been made in the old conversion as well; these were
done before writing & switching to the new conversion, and should be
archived.
The next checkin of this file will discard the old conversion; is is
kept in this checkin to allow it to be retrieved if needed, and to
avoid lossing the bugfixes that have been made to it in the interim.
1999-07-29 22:22:13 +00:00
Fred Drake
2394c98c05
Minor updates.
1999-07-29 22:14:09 +00:00
Fred Drake
ada2de67b3
Use the (new) buildFragment() method of the EsisBuilder rather than
...
implementing it all here.
1999-07-29 22:13:31 +00:00
Fred Drake
f032cdbb24
Some minor cleanup.
1999-07-29 22:03:52 +00:00
Fred Drake
bc2285eb60
Conversion specification, used by a new path through latex2esis.py.
...
The specific markup conversion is coded here instead of an even more
cryptic table in the code of latex2esis.py.
1999-07-29 22:03:11 +00:00
Fred Drake
478a265057
Minor update.
1999-07-29 22:01:39 +00:00
Fred Drake
5772f33b6c
Add support for bzip2 using --bzip2.
1999-07-27 16:29:30 +00:00
Fred Drake
8ea15f3495
Add --zip parameter; make this able to produce .zip files as well as
...
.tgz files.
1999-07-23 16:09:11 +00:00
Fred Drake
06c5a8b52e
Make the default target xml instead of sgml.
1999-07-22 13:57:12 +00:00
Fred Drake
7dbde51f97
Make the default target xml instead of sgml.
...
Use a temporary file to pass results from latex2esis.py to
docfixer.py; this makes for better error detection by make (if the
first pipeline stage fails, make wasn't catching it).
1999-07-22 13:56:51 +00:00
Fred Drake
924b42de9c
When looking for things that might be modules, include *module.c from
...
the Modules/ directory. Most of the remaining undocumented modules
seem to be living there.
1999-06-17 18:49:18 +00:00
Fred Drake
0eb7b2a659
Enhanced docstring and some comments.
...
_begin_macro_rx: Fixed RE that didn't properly allow a space after
the name of the macro. This affects the conversion
of the tutorial.
1999-05-19 17:37:37 +00:00
Fred Drake
c4811d8208
Modify to perform "---" to "—" conversion outside of
...
verbatim-like environments. The list of verbatim-like environments is
a defined by a variable in main().
1999-05-18 17:34:51 +00:00
Fred Drake
c41e1e5f5e
Remove the "---" to "—" conversion; this is wrong in verbatim
...
environments. Move the conversion to esis2sgml.py.
1999-05-18 17:33:01 +00:00
Fred Drake
e779d4f03b
Lots of adjustments to deal with the document content now being stored
...
in a fragment rather than the main document object.
1999-05-10 19:36:52 +00:00
Fred Drake
54fb7fb9d0
Some more fixes.
...
Add controls for some of the esoteric indexing macros.
1999-05-10 19:36:03 +00:00
Fred Drake
2697694e4a
ExtendedEsisBuilder.push(): Override inherited definition. We don't
...
want to push nodes into the document, but into a document
fragment, since we're not necesarily working with something
that's well-formed.
1999-05-07 21:14:28 +00:00
Fred Drake
f79acbdaa1
Fix some bugs introduced in the previous checkin.
1999-05-07 21:12:21 +00:00
Fred Drake
96c00b0b5e
Define & use a Conversion object. It's still really ugly, but at
...
least there's a token object in here now! ;-)
1999-05-07 19:59:02 +00:00
Fred Drake
a871c2e747
Make it work for "manual" documents as well as "howto" documents.
...
This still doesn't understand anything about multiple source files or
checking time dependencies.
1999-05-06 19:37:38 +00:00
Fred Drake
4437fdf265
Make sure latex2html doesn't produce a hard link between foo/foo.html
...
and foo/index.html. Make a copy instead. (Appearantly some tar
openers on non-Unixlike systems can't handle hard links.)
1999-05-03 14:29:07 +00:00
Fred Drake
d2d1eef025
Make sure latex2html doesn't produce a hard link from $part/$part.html
...
and $part/index.html. Make a copy instead. (Appearantly some tar
openers on non-Unixlike systems can't handle hard links.)
1999-05-03 14:27:45 +00:00
Fred Drake
c1db512b2b
Nasty hack to add a --numeric parameter to skip the use of "logical"
...
names.
1999-04-29 18:28:48 +00:00
Fred Drake
c4a623ebdc
Add command line flags to just list the files that contain the
...
offending lines or to include line numbers in the output.
1999-04-22 20:32:21 +00:00
Fred Drake
693a2c6581
Script to locate uses of \module where the module referred to is not
...
the module being documented at that point in the documentation; these
are candidates for conversion to \refmodule, which produces a
hyperlink in the HTML and PDF versions of the output.
1999-04-22 13:08:09 +00:00
Fred Drake
c260c0bcdb
Further refinement, to allow this to handle the library reference as
...
well as the other "manual" documents.
1999-04-14 13:13:32 +00:00
Fred Drake
79d41ccdd3
Add some support for the module index, so this can be used to build
...
the .aux file for any of the "manual" class documents.
1999-04-14 05:02:06 +00:00
Fred Drake
2e1094e4ef
Use #!/usr/bin/env python instead of #!/usr/local/bin/python.
1999-04-09 14:53:35 +00:00
Fred Drake
e3fd1064de
Make this simpler; don't care about the paper size. Require that the
...
files exist in the current directory.
Add "Documenting Python" to the list of documents listed.
1999-03-18 14:57:53 +00:00
Fred Drake
87a42cd61b
Add support for <platform>, some cleanup of module section after
...
creating the <moduleinfo>.
1999-03-11 17:35:12 +00:00
Fred Drake
1acb8740eb
Oops, missed a couple of substitutions in the templates.
1999-03-04 21:33:55 +00:00
Fred Drake
5f7832d125
Allow many more aspects of the generated page to be parameterized, and
...
add a useful usage message. Use 'mkmodindex --help' to display it.
1999-03-04 21:19:57 +00:00
Fred Drake
aaa0d9a3a4
Record the value of $TEXINPUTS in the transcript.
...
Job.message(): New method. Takes care of writing a message to the
user and adding it to the transcript.
1999-03-03 21:57:58 +00:00
Fred Drake
b1d839866c
Obsolete; use the Python version instead.
1999-03-03 20:28:17 +00:00
Fred Drake
8b88093b95
Re-written mkhowto in Python; this should be at least a little more
...
portable.
Several things that had been done by running a python script are now a
matter of importing the right module and running a function with a few
parameters.
1999-03-03 20:24:30 +00:00
Fred Drake
749f943a6b
process(): New function that contains the "orchestration" of the
...
actual work.
main(): Just handle the command line and filename determination,
calling process() to do the work.
These changes make this more import-friendly.
1999-03-03 19:36:23 +00:00
Fred Drake
7c8754fafb
process(): New function that contains the "orchestration" of the
...
actual work.
main(): Just handle the command line and filename determination,
calling process() to do the work.
These changes make this more import-friendly.
1999-03-03 19:25:56 +00:00
Fred Drake
7f492ad7b8
Be more flexible to support platform annotations.
1999-03-02 16:22:56 +00:00
Fred Drake
75ab7a6fa4
Clean up *.pla files -- platform annotation information.
1999-03-02 16:22:26 +00:00
Fred Drake
093c97a36f
ignore_from_idx(): Fixed bug in regular expression.
1999-02-24 18:39:47 +00:00
Fred Drake
2ef38a7a42
Script to combine module index files. Given a list of files that look
...
like modindex.html, create a combined modindex.html file that lists
all the modules. Takes the same parameters as buildindex.py.
1999-02-24 17:33:07 +00:00
Fred Drake
711fe02ac3
process_nodes(): New function.
...
main(): Moved the node processing between input and ouptut to
process_nodes().
1999-02-24 16:36:48 +00:00
Fred Drake
b6cf9a4fc4
Script to help identify undocumented modules. Use -h or --help for
...
usage information.
1999-02-23 23:07:48 +00:00
Fred Drake
93d762fc7a
Mark <verbatim> elements that represent interactive sessions; these
...
become <interpreter-session> elements.
1999-02-18 16:32:21 +00:00
Fred Drake
997eec7cca
Minor adjustments to reflect esis2sgml.py changes.
...
Added "esis" target to only generate the ESIS data.
1999-02-18 16:31:05 +00:00
Fred Drake
607aed7a2c
Some adjustments, mostly to make it more general.
1999-02-18 16:30:16 +00:00
Fred Drake
4cc902f464
Make the _rmtt regular expression deal with the new CSS-friendly
...
changes to the HTML documentation.
1999-02-18 16:11:12 +00:00
Fred Drake
f6838c0f5e
Copy in the stylesheet after latex2html is done.
1999-02-16 20:43:53 +00:00
Fred Drake
fcf57ad959
Copy in the stylesheet after latex2html is done.
1999-02-16 20:28:25 +00:00
Fred Drake
f43ce00531
Make sure errors get propogated.
1999-02-16 20:05:43 +00:00
Fred Drake
efa641c45a
Add an optional parameter to make the script run latex only once to
...
generate an .aux file. This can make HTML generation a bit faster
when print formats aren't needed.
Explained parameters in a comment.
1999-02-15 19:27:07 +00:00
Fred Drake
3618c14f72
Use a common definition for $(SUBMAKE) instead of repeating everything
...
all over the place.
1999-02-15 16:50:28 +00:00
Fred Drake
5d59d3df7f
Added --l2h-config option to add additional initialization files for
...
latex2html. Can be useful in setting up things like the upward
external link for the top of the documents.
1999-02-15 16:27:42 +00:00
Fred Drake
ec5c0b41ae
Revert previous change; there's a better way to do it.
1999-02-10 17:08:00 +00:00
Fred Drake
dfb4e24431
Respond to suggestion from "Albert" <hat@se-46.wpa.wtb.tue.nl> to add
...
document titles to the list of files.
Also added total page count and a note that comments should be
directed to python-docs@python.org .
1999-02-05 20:50:59 +00:00
Fred Drake
bb79438d26
This seems to fix a problem with targeting from the indexes.
1999-02-02 18:57:12 +00:00
Fred Drake
7281b3b779
Updated comments on version of XML package needed.
1999-01-29 22:35:23 +00:00
Fred Drake
1dd152d036
Added support to handle \versionadded in a reasonable way.
1999-01-29 22:12:29 +00:00
Fred Drake
279ca75a5b
Be a little smarter on some attribute values, making an assumption about
...
the DTD.
1999-01-29 21:35:50 +00:00
Fred Drake
3a7ff998ac
fixup_descriptors(): Change the way we look for descriptor nodes;
...
this takes 5 minutes off the conversion of the whole tree by
reducing the number of tree-traversals from 14 to 1.
1999-01-29 21:31:12 +00:00
Fred Drake
666e60095b
Added the Doc/sgml/ directory to the tarball.
1999-01-29 21:22:55 +00:00
Fred Drake
cb65781d93
Rewrite code that converts the little descriptor environments to build
...
the right <signature>s and <description>. This seems to work a lot
better now!
1999-01-29 20:55:07 +00:00
Fred Drake
75930b31e2
Added table entries for \funcline and \funclineni.
1999-01-29 20:09:27 +00:00
Fred Drake
fdfd50f815
Convert <version> to &version;.
1999-01-29 16:29:25 +00:00
Fred Drake
7dab6affba
Update the docstring.
...
Lots of changes to get the paragraph marking to work, and not go into
an infinite recursion.
Start to rationalize markup of method signatures; not complete.
find_all_elements(): similar to getElementsByTagName(), but operates
on the not-quite-legal fragments we deal with here.
Simplifies several individual transforms.
fixup_sectionauthors(): Convert \sectionauthor items to <author> just
after the <section>'s <title>.
1999-01-28 23:59:58 +00:00
Fred Drake
3f3b09657f
Added table entries for \methodline, \methodlineni.
1999-01-28 23:49:37 +00:00
Fred Drake
1453a8caf9
Constructor arguments for classes should be called <args>.
1999-01-28 23:10:48 +00:00
Fred Drake
ffc4811a40
Simplify slightly.
1999-01-27 18:40:36 +00:00
Fred Drake
a49a4eabbf
Add "term" to AUTOCLOSE.
1999-01-22 22:48:24 +00:00
Fred Drake
43278f01dc
convert(): Added parameter "autoclose", which should be a sequence of
...
general identifiers for which closing tags will be omitted
when SGML is generated. This can be used to tell the markup
generator to drop stuff like </para>. Note that it needs to
be possible for the closing tag to *always* be omitted for it
to be included in "autoclose".
main(): Added command-line option "-a" / "--autoclose" to set the
list of general identifiers passed to the convert() function
as the "autoclose" parameter. The list may only be specified
once (not additive) and GIs should be comma-separated. The
default list includes only "para".
1999-01-20 20:35:05 +00:00
Fred Drake
0a5b8de5e2
Modified the "sgml" and "xml" targets to stop if the sub-makes fail in
...
any subdirectory; don't continue with remaining subdirs.
Added "api", "ext", "lib", "mac", "ref", and "tut" targets to only do
submakes in those directories. This is just a lot easier to use than
to cd into the subdir and use make.rules directly.
1999-01-20 17:26:56 +00:00
Fred Drake
4259f0db04
create_module_info(): If there's a \moduleauthor, move it to an
...
<author> inside the <moduleinfo> element.
Fix problems with paragraph identification.
1999-01-19 23:09:31 +00:00
Fred Drake
36dfe58694
isnmtoken(), istoken(): Fix to ensure the regex has to match the
...
entire attribute value.
Add ability to save list of "empty" elements to a file -- enabled by
constant in the code.
1999-01-19 23:03:04 +00:00
Fred Drake
2664db9f76
handle_labels(): Fix problem for document fragments containing more
...
than one "root" that prevented all the <label id=...> items
from being promoted to id attributes on the enclosing chapter/
section/... properly.
1999-01-19 21:46:48 +00:00
Fred Drake
d6ced7d199
convert(): Change the element name remapping to convert <refmodule>
...
to <module link>.
1999-01-19 17:11:23 +00:00
Fred Drake
f82e4ab617
format_attrs(): Attempt a bit more minimization for SGML output.
1999-01-19 17:10:31 +00:00
Fred Drake
589bc63e84
Add a "tarball" target.
1999-01-14 22:35:05 +00:00
Fred Drake
6038f54b74
Adjust so that we are no longer using special entities for well-known
...
names. These are too much of a pain for occaissional authors.
1999-01-14 21:44:56 +00:00
Fred Drake
3effeedad3
Shorten the name of the <rfc> "number" attribute to "num".
1999-01-14 21:18:52 +00:00
Fred Drake
d24167baf2
Make <rfc> no longer an empty element but a container. The text
...
currently generated by the LaTeX and LaTeX2HTML processes is generated
here as well, making it more flexible in the SGML version.
Reduce the <args> element so that <optional> goes away; just use
square brackets to indicate what's optional. This makes it easier to
read than the LaTeX, and the processor can do any checking it needs to
in order to make sure it's legit. Possible shortcoming: DSSSL
processors may need more explicit markup. Can probably hack around it
for this case, but we'll see.
1999-01-14 21:18:03 +00:00
Fred Drake
f8ebb5521d
Several new functions to re-write tables to be at least partly
...
conformant with the OASIS Exchange model. There's a little more
massage left to do, but not much.
1999-01-14 19:45:38 +00:00
Fred Drake
a50a1df588
Added clean and clobber targets.
1999-01-14 18:26:23 +00:00
Fred Drake
54bad44f25
Update to the latest version of Michael Ernst's script.
1999-01-14 18:17:07 +00:00
Fred Drake
3a7a3d745d
"Driver" makefile to convert all documents to SGML or XML at once.
1999-01-14 18:13:59 +00:00
Fred Drake
7727416686
Add usage of the "driver" Makefile.
1999-01-14 18:12:33 +00:00
Fred Drake
9d1c3b565f
Elaborate a comment on the format of the table that drives the
...
conversion.
1999-01-14 18:10:09 +00:00
Fred Drake
d7acf02290
Adjustments to allow elements with subelements as parameters. This is
...
used to deal with the table headings and entries.
An additional flag in the element table is used to indicate elements
which have no "general" content, but which do have subelement
content. These must be flagged distinctly from empty elements.
Currently used for \lineii, \lineiii, and \lineiv.
1999-01-14 17:38:12 +00:00
Fred Drake
79ad1f19dc
Escape special characters on output.
1999-01-14 17:06:09 +00:00
Fred Drake
701f10fbea
Simplify command that extracts the number of pages from a PostScript
...
file; use "grep -c" instead of "grep | wc -l | cut ... | tr ...".
1999-01-12 19:28:41 +00:00
Fred Drake
8e2c9457a2
output_body(): For <address> elements, just skip, since they're
...
always part of the page trailer.
1999-01-11 22:30:34 +00:00
Fred Drake
ed94dde4b9
No longer useful.
1999-01-08 15:48:47 +00:00
Fred Drake
dd21c32169
It's finally gone!
1999-01-08 15:40:16 +00:00
Fred Drake
c4e9263010
Add a few comments.
1999-01-08 15:32:27 +00:00
Fred Drake
c58f346374
New support scripts for HTML->info conversion that use Michael Ernst's new
...
conversion tools.
1999-01-08 15:27:17 +00:00
Fred Drake
3fe1d32693
New conversion tools for HTML->info from Michael Ernst
...
<mernst@cs.washington.edu>.
Thanks!
1999-01-08 15:25:29 +00:00
Fred Drake
637ad47e61
convert(): Make sure no line has trailing whitespace. (docfixer.py
...
checks for \n\n as a paragraph separator, LaTeX allows white
space between the newlines.)
1999-01-07 18:47:07 +00:00
Fred Drake
fcc5910090
Preliminary code to mark paragraphs. Seems to work, but very slow.
1999-01-06 22:50:52 +00:00
Fred Drake
26f0f65653
Remove obsolete comment.
1999-01-05 20:53:43 +00:00
Fred Drake
3b07480a17
trim_ignored_letters(): Simplify a little.
1999-01-04 22:00:56 +00:00
Fred Drake
03a0235793
Print a line to the console reporting the number of index nodes
...
processed. This can be interesting to see.
1998-12-28 20:46:53 +00:00
Fred Drake
aaed9710e9
create_module_info(): New function: Modify a <section> to create a
...
<moduleinfo> element based on various meta information, and
strip some cruftiness. This is more usable for information
extraction, and organizes the information more clearly.
cleanup_synopses(): Rewrite to use create_module_info(), so this
will work with multi-rooted "documents".
1998-12-10 20:25:30 +00:00
Fred Drake
4abcffb233
Don't pass around a list of known empty elements, since the ESIS
...
contains "e" events for them. This wasn't used anyway.
1998-12-10 18:31:37 +00:00
Fred Drake
fba0ba2a6f
Added a transform to start cleaning up the modulesynopsis stuff a
...
little; more thinking is needed about what we really want.
1998-12-10 05:07:09 +00:00
Fred Drake
c166331cd3
Handle SGML variant as well as XML variant. SGML is *much* more
...
likely to be used.
1998-12-10 04:56:00 +00:00
Fred Drake
86bc7b01b5
General comments on what's here and how to try it out. Note
...
dependence on the XML package.
1998-12-02 17:21:35 +00:00
Fred Drake
3695b1212c
Support conversions to both SGML and XML; SGML is the "default".
...
Add dependency on esistools.py for the ESIS intermediate files.
1998-12-01 19:05:56 +00:00
Fred Drake
aeea9810cd
Use esistools.
...
Lots of changes to the conversion table.
1998-12-01 19:04:12 +00:00
Fred Drake
4db5b4636c
Use esistools.
...
Generate ESIS data instead of XML.
Misc. changes to some transforms.
1998-12-01 19:03:01 +00:00
Fred Drake
f077b9d61f
Use esistools, getopt.
1998-12-01 19:01:53 +00:00
Fred Drake
3843bae969
Utility functions and misc. classes used in handling ESIS data.
1998-12-01 19:00:58 +00:00
Fred Drake
f954b6516e
Remove $(CUTCRUFT) garbage; now in fixgenents.sh.
...
Separate ESIS generation from XML generation. This will evolve a bit
more in a couple of days.
1998-11-30 22:31:45 +00:00
Fred Drake
3d5e2c032d
Move nasty cruft from make.rules' $(CUTCRUFT) here, mostly to clean up
...
make.rules.
1998-11-30 22:30:29 +00:00
Fred Drake
ca6d6355d7
l2hoption: Do the "right thing" to quote the right-hand-side of Perl
...
assignments. This allows '"', '$', and '@' to be included in
the values passed to parameters like --address.
1998-11-30 20:30:26 +00:00
Fred Drake
7777e36c21
Add a -address parameter to the LaTeX2HTML command line to direct
...
documentation comments appropriately. In response to comment from
Martijn Faassen <faassen@vet.uu.nl>.
1998-11-30 20:27:31 +00:00
Fred Drake
42f5298ab5
Several small adjustments.
1998-11-30 14:45:24 +00:00
Fred Drake
87dfd3cfbf
Handle output of \geq and \leq.
1998-11-30 14:36:26 +00:00
Fred Drake
4c5e533693
Do the right stuff to convert what was originally \e, \ldots, and ---
...
in the LaTeX sources.
1998-11-25 19:28:02 +00:00
Fred Drake
d8faf85d40
Supplemental rules to convert a .tex file to a .xml file. Both XML and
...
SGML will be supported soon, probably using an ESIS representation saved
in a temp file.
1998-11-24 17:40:33 +00:00
Fred Drake
6942e57f87
Script to convert things like <C/> and <Cpp/> to &C; and &Cpp;. This is
...
something that con't be done with the DOM as far as I can tell.
1998-11-24 17:38:49 +00:00
Fred Drake
1cb330c383
The & character is also escaped using \.
1998-11-23 23:11:12 +00:00
Fred Drake
1ff6db484f
Add some additional cleanup transformations.
1998-11-23 23:10:35 +00:00
Fred Drake
5701482ea7
Fix comment regex so we don't screw up structured comments with
...
different internal indentation levels.
1998-11-23 18:21:54 +00:00
Fred Drake
0320473a29
Script to squirrel around with the DOM tree of document fragments from the
...
LaTeX-based ESIS streams to be a little better structured, and generally
perform clean-up.
Preliminary.
1998-11-23 17:02:03 +00:00
Fred Drake
30a68c7a2b
Moved into tools/sgmlconv/.
1998-11-23 16:59:39 +00:00
Fred Drake
63de8f6d55
Moving to sgmlconv/ subdir.
1998-11-23 16:58:48 +00:00
Fred Drake
bbd7509dbe
Fix up the extraction of optional parameters a little.
...
Be more informative in an exception message.
1998-11-23 16:30:18 +00:00
Fred Drake
c16149b17b
Some cleanup.
...
Don't duplicate the information on what's empty; rely on the input
data for that. (This means that the DOM may need more work.)
1998-11-23 15:14:18 +00:00
Fred Drake
96b07a9453
Fix some minor problems.
...
Make the table of attribute information contain only one kind of
entry. Simplifies some stuff in subconvert().
1998-11-23 15:12:00 +00:00
Fred Drake
99ff8c4361
First cut at a script to generate SGML/XML from an ESIS event stream,
...
probably only usable for the Python docs. But also probably more
useful than latex2esis.py.
1998-11-18 23:28:24 +00:00
Fred Drake
95f4f92b47
First cut at a script to generate ESIS events from LaTeX source,
...
probably only usable for the Python docs.
1998-11-18 23:27:24 +00:00
Fred Drake
566b6d5b59
Support the use of bibtex. This is transparent to the user.
...
Switch from bash to ksh, in the hope that more systems support it (one
report of a site without an available bash).
1998-10-27 21:59:03 +00:00
Fred Drake
d29cf379b9
Added --tools option, to package only the framework (no documents).
1998-10-21 14:26:26 +00:00
Fred Drake
fbddddee49
Reflect new name of index style file.
1998-10-19 21:48:05 +00:00
Fred Drake
9dcc9f7764
No longer needed since we have nice, contributed navigation buttons.
1998-10-19 21:40:45 +00:00
Fred Drake
a5de730d2d
If building HTML and the icons should be served from the same
...
directory as the HTML (--iconserver .), copy the icons into place.
Clarify that lynx is needed for --text in the usage message.
Fix a typo in a comment.
1998-10-19 19:14:42 +00:00
Fred Drake
b521095952
In build_html(), strip off leading "./" from filename, added by
...
kpsewhich. This caused a problem with the latest latex2html beta.
1998-10-16 17:34:34 +00:00
Fred Drake
437ff8600a
Change the default split level to not split on marked \paragraph and
...
\subparagraph sections. Indicate the default in the --help message.
1998-10-07 16:46:54 +00:00
Fred Drake
b0b1900198
If --debug was used, don't delete the temporary .perl file used to
...
pass options to latex2html.
1998-10-07 16:41:40 +00:00
Fred Drake
8c1e114d1a
Don't attempt to add paragraph and subparagraph sections to the PDF
...
outline.
Work around font-long bogosity caused by ' in docstring.
1998-10-07 14:12:20 +00:00
Fred Drake
47f69067d5
Script to generate page counts of the PostScript files.
1998-08-28 21:16:28 +00:00
Fred Drake
e1feb8f2dc
Support long options that take arguments of the form --option=value as well
...
as --option value.
Minor nits cleaned up.
1998-08-28 20:21:04 +00:00
Fred Drake
9f6f0da084
Improved some error messages for command line processing.
...
Added --all to produce all formats at once.
1998-08-12 18:07:51 +00:00
Fred Drake
78b8c3d0d6
Oops, the --text option wasn't documented!
1998-08-12 17:52:16 +00:00
Fred Drake
c794c38187
Added a comment about not using a symbolic link to access the script.
1998-08-12 17:50:07 +00:00
Fred Drake
15c417eb77
Helper script used in creating navigation buttons.
1998-08-11 19:35:03 +00:00
Fred Drake
af06a0b4ee
Use Perl's rename() function instead of system(); there's no need for two
...
additional processes for each name change!
1998-08-11 18:17:47 +00:00
Fred Drake
f6b6bbceb6
Add a comment explaining that this script is probably not useful outside the
...
standard Python documentation, since the mkhowto.sh script is. Let there be
no doubts....
1998-08-11 14:10:40 +00:00
Fred Drake
077fffa874
The letter headings must be requested explicitly with --letters.
1998-08-07 20:49:54 +00:00
Fred Drake
7cbf462acf
Allow multi-column indexes to be produced.
1998-08-07 19:50:13 +00:00
Fred Drake
9940bd717c
Variant of AMK's patch to produce text versions of HOWTO documents.
...
This ensures that the text version uses latex2html's -split 1 option, without
affecting HTML produced in the same run, and also minimizes the number of
l2h runs needed if --split 1 was used for an HTML run.
1998-08-06 20:15:20 +00:00
Fred Drake
11300cc71e
build_html(): Simplify, so there's only one version of the latex2html
...
command line.
l2hoption(): Convenience function, to write out an option to the aux. init.
file only if set.
Added --iconserver option to set the $ICONSERVER variable in latex2html; this
requires the use of an auxillary init. file since this can't be initialized
using a standard latex2html command-line option. So the aux. init. file is
used for just about all the special options since it has to be written anyway
when $ICONSERVER needs to be set.
1998-08-05 04:48:18 +00:00
Fred Drake
8cab549c0a
use_latex(): Hack to pass .syn files though uniq, so that the last module
...
in a HOWTO document isn't listed in the synopsis table twice. This
will do until the real bug is found (low priority!).
1998-07-23 19:13:52 +00:00
Fred Drake
e87ab1fbf2
Fix definition of release_version (global).
1998-05-19 19:37:55 +00:00
Fred Drake
a4565b0796
Update to use latex2html 98.1p5.
1998-05-15 17:14:17 +00:00
Fred Drake
8dbf46a79e
Update to use latex2html 98.1p5.
...
Cleanup temporary files produced by latex2html in the output directory.
1998-05-15 17:13:08 +00:00
Fred Drake
8d1b3384c3
Remove debugging echo.
1998-05-15 13:38:21 +00:00
Fred Drake
df825a10fc
Fix the fix to allow the .tex document sources not live in ".".
1998-05-14 20:36:49 +00:00
Fred Drake
25d4e2873c
Mostly spurious change to ensure that everyone's version of this picks up the
...
execute bit.... problem discovered by Guido.
1998-05-14 20:07:10 +00:00
Fred Drake
f4fc476885
Don't run tools/toc2bkm.py unless we're building PDF.
...
Change the way TEXINPUTS gets defined to ensure that the directory containing
the main document file comes before any other dir, to allow documents to have
files that "override" like-named files elsewhere on the search path. Guido
discovered we needed this.
1998-05-14 20:03:14 +00:00
Fred Drake
72dd58d90e
Use .tgz instead of .tar.gz for the output file name.
1998-05-11 21:08:39 +00:00
Fred Drake
d5d473fd5c
Add --letter option, similar to --a4. This is a no-op, but can be used from
...
a Makefile: mkhowto.sh --$(PAPER).
1998-05-11 20:40:24 +00:00
Fred Drake
58ff112e7f
Don't be so ugly as to use "set -x" to get the executed commands printed.
1998-05-11 19:06:26 +00:00
Fred Drake
1a3541c29c
Oops, better add it to the usage message!
1998-05-11 19:04:56 +00:00
Fred Drake
3504952781
Add easy-to-use support for A4 paper.
1998-05-11 19:04:06 +00:00
Fred Drake
f2fa1e2afe
Accept the release number on the command line instead of hardcoding it.
1998-05-11 18:52:24 +00:00
Fred Drake
323dc70de5
Don't be so ugly as to use "set -x" to get the executed commands printed.
1998-05-11 18:41:16 +00:00
Fred Drake
8ffa21c7aa
Adjust to new file layout.
1998-05-08 15:37:13 +00:00
Fred Drake
f4166a478a
Some versions of latex2html don't automatically append the .tex extension to
...
the name of the main .tex source file if it's not in the current directory.
1998-05-08 04:00:56 +00:00
Fred Drake
4a9129c7e8
/bin/sed works on both Solaris and RedHat Linux; /usr/bin/sed does not.
1998-05-08 03:42:23 +00:00
Fred Drake
19c7c84db8
Be a little more robust handling filenames.
1998-05-07 21:20:39 +00:00
Fred Drake
bf332696a1
Add support for a --pdf option to cause a PDF file to be created instead;
...
most of the processing is the same and has to be done anyway.
1998-05-07 17:28:42 +00:00