From: Fred Drake <fdrake@acm.org>
Date: Wed, 2 Dec 1998 17:21:35 +0000 (+0000)
Subject: General comments on what's here and how to try it out.  Note
X-Git-Tag: v1.5.2b1~137
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=86bc7b01b59cadc720ff8a84219afc66ffb1f6a4;p=python

General comments on what's here and how to try it out.  Note
dependence on the XML package.
---

diff --git a/Doc/tools/sgmlconv/README b/Doc/tools/sgmlconv/README
new file mode 100644
index 0000000000..b7bdddbdd5
--- /dev/null
+++ b/Doc/tools/sgmlconv/README
@@ -0,0 +1,23 @@
+These scripts and Makefile fragment are used to convert the Python
+documentation in LaTeX format to SGML.  XML is also supported as a
+target, but is unlikely to be used.
+
+This material is highly preliminary and incomplete.  The XML omnibus
+package developed by the Python XML-SIG is required.  See
+http://www.python.org/sigs/xml-sig/ for more information on the
+package.
+
+To convert a document to SGML:
+
+	cd Doc/<document-dir>
+	make -f ../tools/sgmlconv/make.rules TOOLSDIR=../tools
+
+To generate XML instead, use:
+
+	cd Doc/<document-dir>
+	make -f ../tools/sgmlconv/make.rules TOOLSDIR=../tools xml
+
+Note that building the second target format is fast because both
+conversions use the same intermediate format (an ESIS event stream).
+
+Please send comments and bug reports to python-docs@python.org.