blob: 7b22acb38ca54986abe30c8ca3dadd3cb2fd1919 [file] [log] [blame]
Fred Drake86bc7b01998-12-02 17:21:35 +00001These scripts and Makefile fragment are used to convert the Python
Fred Drake478a2651999-07-29 22:01:39 +00002documentation in LaTeX format to SGML or XML. Though I originally
3thought that the XML was unlikely to be used, tool support for XML
4is increasing quickly enough that it may well be the final format.
5(It is the default output format when using the makefiles included
6here.)
Fred Drake86bc7b01998-12-02 17:21:35 +00007
Fred Drake77274161999-01-14 18:12:33 +00008This material is preliminary and incomplete. The XML omnibus package
Fred Drake7281b3b1999-01-29 22:35:23 +00009developed by the Python XML-SIG is required; specifically, the version
10available in the public CVS repository. See
Fred Drake86bc7b01998-12-02 17:21:35 +000011http://www.python.org/sigs/xml-sig/ for more information on the
12package.
13
Fred Drake77274161999-01-14 18:12:33 +000014To convert all documents to SGML:
15
16 cd Doc/
Fred Drake478a2651999-07-29 22:01:39 +000017 make -f tools/sgmlconv/Makefile sgml
Fred Drake77274161999-01-14 18:12:33 +000018
Fred Drake86bc7b01998-12-02 17:21:35 +000019To convert a document to SGML:
20
21 cd Doc/<document-dir>
22 make -f ../tools/sgmlconv/make.rules TOOLSDIR=../tools
23
24To generate XML instead, use:
25
26 cd Doc/<document-dir>
27 make -f ../tools/sgmlconv/make.rules TOOLSDIR=../tools xml
28
29Note that building the second target format is fast because both
30conversions use the same intermediate format (an ESIS event stream).
Fred Drake77274161999-01-14 18:12:33 +000031This is true regardless of whether you build SGML or XML first.
Fred Drake86bc7b01998-12-02 17:21:35 +000032
33Please send comments and bug reports to python-docs@python.org.