Commit Graph

441 Commits

Author SHA1 Message Date
Fred Drake a281665972 No need to run make twice here. 2001-10-25 15:13:30 +00:00
Fred Drake f10584cb11 Do a little bit more to try and add <link> elements to the header, not that
Mozilla 0.9.5 can make intelligent use of them.  Specifically, this causes
the "Acknowledgements" and "Global Module Index" pages to acquire "up"
links in the Mozilla "Site Navigation Bar".
This partially responds to SF bug #469772.
2001-10-22 15:07:16 +00:00
Fred Drake 92350b3a1f New markup: \note{...} and \warning{...} 2001-10-09 18:01:23 +00:00
Fred Drake ac1af8093e Handle PEP references the same way RFC references. 2001-09-29 19:07:22 +00:00
Fred Drake 583061a10f Fix up whitespace in <args> elements; reduce sequences of consecutive
whitespace characters to a single space.
Small changes elsewhere, mostly to clean up the code a little.
2001-09-29 05:05:25 +00:00
Fred Drake 3c171d1b9f Convert to string methods.
For the real document element, make sure the prolog is migrated into
the document element so it isn't left stranded.

Make fixup_trailing_whitespace() whitespace do what was really intended.

Add the *desc environments used in the C API manual to the list of
things that can exist at the paragraph level so they don't get wrapped
in <para>...</para>.
2001-09-28 17:14:35 +00:00
Fred Drake 0f9bfd3dda Convert most uses of the string module to string methods.
(string.join() lives!)
2001-09-28 16:26:13 +00:00
Fred Drake 876389e5d8 Do not distinguish \refmodule from \module in the generated output;
whether or not a link will be generated will depend on the link database.
Add a couple of explanatory comments for one of the stranger constructs
(giving input an empty name).
2001-09-27 17:01:59 +00:00
Fred Drake 9213b7a961 Re-write <ulink> elements as described in the conversion spec. 2001-09-27 16:52:22 +00:00
Fred Drake baacc08ead Turn \input, \include, and \verbatiminput into XInclude elements instead
of something ad-hoc.
2001-09-27 15:49:23 +00:00
Fred Drake b6fa78930e Add support for some more markup that had slipped in.
Fixed a typo in a comment.
2001-09-27 04:18:39 +00:00
Fred Drake 29a67ced72 Update to support \mailheader and 5-column tables. 2001-09-25 20:58:13 +00:00
Fred Drake 9eda3aebb8 Simplify a helper by returning fewer values. 2001-09-25 20:57:36 +00:00
Fred Drake 1cb560a653 Do more to be compatible with Windows/CygWin. Make error messages more
informative when a child process dies with an error.

This is a variation of parts of SF patch #429611.
2001-08-10 20:17:09 +00:00
Fred Drake e54acfd8b2 Add option to push the development docs to SF without announcing, for
when the changes are just too small.
2001-08-08 05:41:01 +00:00
Fred Drake 1ca78b6b70 Change the command lines to use a similar "phrasing" to that used in the
other documentation makefiles.  This is probably not sufficient to run
the conversion on Windows, but goes at least part way.
2001-07-18 18:32:38 +00:00
Fred Drake 3cae66bdbc Script to re-write @FOO@-style marks with values, initializing the
replacement for @DATE@ from a TeX file containing a \date{...} mark
(such as texinputs/boilerplate.tex).

This will be used to re-write the html/index.html.in file instead of
a combination of grep, date, and sed -- this is more portable to non-Unix
platforms.

This solves part of the problem reported in SF patch #429611, but does
not use the suggested patch.
2001-07-17 16:46:14 +00:00
Fred Drake aebbca3b61 Job.__init__(): Only create the builddir directory if it will be used (by
building the HTML or text documentation).  There is no need to create
    it for other formats.

Job.build_html():  The builddir parameter is always passed in, so it need
    not be optional.
2001-07-17 14:46:09 +00:00
Fred Drake 44845ba67d Change the target name for \kbd. 2001-07-14 03:10:20 +00:00
Fred Drake 602cf584be Generate a more meaningful message regarding the type of the documentation
release being discussed.
2001-07-12 21:50:10 +00:00
Fred Drake 03e88da81b Add conversion information for the grammar production support (preliminary). 2001-07-09 15:00:42 +00:00
Fred Drake 44835d8e7a Move & update a comment.
Add support for the \ulink macro.
2001-07-07 06:00:36 +00:00
Fred Drake de6dc1e11c Change the way notification mails are sent so people who respond to the
update announcements do not get bounces from trying to send mail to my
laptop, which has an identity crisis due to constant relocation.
2001-07-06 23:45:16 +00:00
Fred Drake 0a650d77d5 Add entries for recently defined markup. 2001-07-06 21:13:51 +00:00
Fred Drake dde993c15d Simplification to mirror a better conversion specification and more
powerful latex2esis.py.
2001-07-06 21:03:30 +00:00
Fred Drake b5fc0ab099 Allow optional arguments to LaTeX macros to span lines. This is legal in
LaTeX and we have at least one occurance of that in the content, so this
script needs to support it as well.
2001-07-06 21:01:19 +00:00
Fred Drake f015d9a5f6 Give the pattern used to pick out a source anchor a more specific pattern. 2001-06-23 04:35:09 +00:00
Fred Drake bfd80dd8c0 Miscellaneous code cleanups.
Make sure we do not lose track of the build directory -- convert a user-
supplied directory to an absolute path.
2001-06-23 03:06:01 +00:00
Fred Drake 9ca78ac57f Adjust to understand use of either single- or double-quotes to quote
attribute values, and make the logic surrounding the platform
annotations just a little easier to read.  Also make the platform
notes appear in the generated page; they were supposed to, but did not.
2001-06-22 17:11:30 +00:00
Fred Drake 66a0a0a9b6 Make the option processing more robust.
Add a -F option similar to "cvs commit -F <file>".
Add a -t option to allow specifying the prefix to the directory into which
the docs should be unpacked (useful when I start trying out new styles for
the presentation).
2001-06-12 13:31:37 +00:00
Fred Drake 9a374186fc New solution to the "Someone stuck a colon in that filename!" problem:
Allow colons in the labels used for internal references, but do not
expose them when generating filename.
2001-05-29 19:53:46 +00:00
Fred Drake 964c074a62 Hack to make this play nicer with *old* versions of Python: os.path.abspath()
was not available in Python 1.5.1.  (Yes, a user actually tried to use this
with that version of Python!)
2001-05-29 16:10:07 +00:00
Fred Drake 404ac97207 If the input line does not contain enough fields, raise a meaningful
error.
2001-05-29 15:25:51 +00:00
Fred Drake 283b352d48 Update the directory names to match changes at SourceForge. 2001-05-09 16:33:34 +00:00
Fred Drake af922187ae Job.build_html(): Be more robust in ensuring about.html exists; copying
the right HTML file to the name about.html is needed even if the
    --numeric option was not given -- some other name may have been
    assigned due to some non-determinism in the algorithm use to perform
    name allocation.  ;-(

This closes the "About..." portion of SF bug #420216.
2001-05-09 04:03:16 +00:00
Fred Drake 34b48e844e Update publish-to-SourceForge scripts to automatically determine if the
branch is the head (development) branch or a maintenance brach, and use
the appropriate target directory for each.
2001-04-22 06:20:31 +00:00
Fred Drake e99b97e58a encode(): Handle Latin-1 input characters better. 2001-04-21 06:01:53 +00:00
Fred Drake bda05564de Add support for <memberline/> (needs markup improvement!).
Update <versionadded/> to recent addition of optional explanatory text;
make the explanation text take the same attribute name for both
<versionadded/> and <versionchanged/>.
2001-04-21 06:00:51 +00:00
Fred Drake e1f3ed6b58 Update the helper scripts that push development docs to SourceForge;
this version avoids having to build a separate authenticated connection
to push the update-docs.sh script to SF.
2001-04-13 05:13:55 +00:00
Fred Drake 20931fb3f4 Update the XML conversion specification. 2001-04-10 19:59:31 +00:00
Fred Drake c81d470648 Allow the <author/> element to appear before a paragraph without being
made a part of the paragraph.
2001-03-29 23:31:22 +00:00
Fred Drake 7190247e0b Remove the annoying __version__ definitions. 2001-03-23 17:09:02 +00:00
Fred Drake 3e8f921fb9 Lots of small changes to make this work with the Python DOM bindings
(minidom in particular); it was using PyDOM which is now obsolete.

Only write the output file on success -- this avoids updating the timestamp
on the file on failure, which confuses "make".
2001-03-23 17:01:47 +00:00
Fred Drake 2262a80fb3 Pick up the "encode" function from esistools instead of defining our own
(broken) version.

Remove Conversion.err_write() -- use dbgmsg() consistently.
2001-03-23 16:53:34 +00:00
Fred Drake f6c115ff2f Re-write to no longer depend on an old version of PyXML. This now
implements a SAX XMLReader interface instead of the old Builder interface
used with PyDOM (now obsolete).

This only depends on the standard library, not PyXML.
2001-03-23 16:42:08 +00:00
Fred Drake a4699a71b8 Pick the "escape" function from the standard library instead of from PyXML. 2001-03-23 16:38:12 +00:00
Fred Drake ce19496ec1 Add conversions for more of the markup -- not all of this was around when
this file was written!
2001-03-23 16:29:06 +00:00
Fred Drake 0c8f6643c6 Remove debugging "set -x". 2001-03-03 19:57:26 +00:00
Fred Drake 3f4e717c31 Revise the scripts I use to update the documentation on the SourceForge
site.  These now seem (slightly) more reliable, and easier to work with
since update-docs.sh no longer needs to be installed ahead of time on
my account at SF.
2001-03-02 21:05:58 +00:00
Fred Drake cfef0096f9 Job.build_html(): When formatting HTML into more than one HTML page, and
not doing the \label{foo} --> foo.html transformation (--numeric was
    specified on the command line), still look to see if there is an
    "About this document..." node and copy that to "about.html", since the
    page footers use that as the target.
2001-03-02 16:26:45 +00:00
Fred Drake 50d1fcf61c Add an option allowing the user to determine where the output HTML is built.
Provide a way to set the paper size by name instead of only supporting
separate options for each size.
2001-02-19 19:18:09 +00:00
Fred Drake e4f1c3276a Be more careful to avoid spurious output from the shell script that
unpacks the development version of the docs on SF.
2001-02-14 21:26:31 +00:00
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