summaryrefslogtreecommitdiffstats
path: root/Doc/tools/sgmlconv/README
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-12-02 17:21:35 (GMT)
committerFred Drake <fdrake@acm.org>1998-12-02 17:21:35 (GMT)
commit86bc7b01b59cadc720ff8a84219afc66ffb1f6a4 (patch)
treed8ee402b39273dee9e21a0e9ac78497e33499bb7 /Doc/tools/sgmlconv/README
parent6d26f4b1883ea92ebe8060e9706223b74fcae317 (diff)
downloadcpython-86bc7b01b59cadc720ff8a84219afc66ffb1f6a4.zip
cpython-86bc7b01b59cadc720ff8a84219afc66ffb1f6a4.tar.gz
cpython-86bc7b01b59cadc720ff8a84219afc66ffb1f6a4.tar.bz2
General comments on what's here and how to try it out. Note
dependence on the XML package.
Diffstat (limited to 'Doc/tools/sgmlconv/README')
-rw-r--r--Doc/tools/sgmlconv/README23
1 files changed, 23 insertions, 0 deletions
diff --git a/Doc/tools/sgmlconv/README b/Doc/tools/sgmlconv/README
new file mode 100644
index 0000000..b7bdddb
--- /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.