blob: f41218e4d859d8dc2514673c2c0a49e9ba0334fa [file] [log] [blame]
Fred Drake86bc7b01998-12-02 17:21:35 +00001These scripts and Makefile fragment are used to convert the Python
2documentation in LaTeX format to SGML. XML is also supported as a
3target, but is unlikely to be used.
4
Fred Drake77274161999-01-14 18:12:33 +00005This material is preliminary and incomplete. The XML omnibus package
Fred Drake7281b3b1999-01-29 22:35:23 +00006developed by the Python XML-SIG is required; specifically, the version
7available in the public CVS repository. See
Fred Drake86bc7b01998-12-02 17:21:35 +00008http://www.python.org/sigs/xml-sig/ for more information on the
9package.
10
Fred Drake77274161999-01-14 18:12:33 +000011To convert all documents to SGML:
12
13 cd Doc/
14 make -f tools/sgmlconv/Makefile
15
Fred Drake86bc7b01998-12-02 17:21:35 +000016To convert a document to SGML:
17
18 cd Doc/<document-dir>
19 make -f ../tools/sgmlconv/make.rules TOOLSDIR=../tools
20
21To generate XML instead, use:
22
23 cd Doc/<document-dir>
24 make -f ../tools/sgmlconv/make.rules TOOLSDIR=../tools xml
25
26Note that building the second target format is fast because both
27conversions use the same intermediate format (an ESIS event stream).
Fred Drake77274161999-01-14 18:12:33 +000028This is true regardless of whether you build SGML or XML first.
Fred Drake86bc7b01998-12-02 17:21:35 +000029
30Please send comments and bug reports to python-docs@python.org.