Fred Drake | 86bc7b0 | 1998-12-02 17:21:35 +0000 | [diff] [blame] | 1 | These scripts and Makefile fragment are used to convert the Python |
Fred Drake | 478a265 | 1999-07-29 22:01:39 +0000 | [diff] [blame^] | 2 | documentation in LaTeX format to SGML or XML. Though I originally |
| 3 | thought that the XML was unlikely to be used, tool support for XML |
| 4 | is increasing quickly enough that it may well be the final format. |
| 5 | (It is the default output format when using the makefiles included |
| 6 | here.) |
Fred Drake | 86bc7b0 | 1998-12-02 17:21:35 +0000 | [diff] [blame] | 7 | |
Fred Drake | 7727416 | 1999-01-14 18:12:33 +0000 | [diff] [blame] | 8 | This material is preliminary and incomplete. The XML omnibus package |
Fred Drake | 7281b3b | 1999-01-29 22:35:23 +0000 | [diff] [blame] | 9 | developed by the Python XML-SIG is required; specifically, the version |
| 10 | available in the public CVS repository. See |
Fred Drake | 86bc7b0 | 1998-12-02 17:21:35 +0000 | [diff] [blame] | 11 | http://www.python.org/sigs/xml-sig/ for more information on the |
| 12 | package. |
| 13 | |
Fred Drake | 7727416 | 1999-01-14 18:12:33 +0000 | [diff] [blame] | 14 | To convert all documents to SGML: |
| 15 | |
| 16 | cd Doc/ |
Fred Drake | 478a265 | 1999-07-29 22:01:39 +0000 | [diff] [blame^] | 17 | make -f tools/sgmlconv/Makefile sgml |
Fred Drake | 7727416 | 1999-01-14 18:12:33 +0000 | [diff] [blame] | 18 | |
Fred Drake | 86bc7b0 | 1998-12-02 17:21:35 +0000 | [diff] [blame] | 19 | To convert a document to SGML: |
| 20 | |
| 21 | cd Doc/<document-dir> |
| 22 | make -f ../tools/sgmlconv/make.rules TOOLSDIR=../tools |
| 23 | |
| 24 | To generate XML instead, use: |
| 25 | |
| 26 | cd Doc/<document-dir> |
| 27 | make -f ../tools/sgmlconv/make.rules TOOLSDIR=../tools xml |
| 28 | |
| 29 | Note that building the second target format is fast because both |
| 30 | conversions use the same intermediate format (an ESIS event stream). |
Fred Drake | 7727416 | 1999-01-14 18:12:33 +0000 | [diff] [blame] | 31 | This is true regardless of whether you build SGML or XML first. |
Fred Drake | 86bc7b0 | 1998-12-02 17:21:35 +0000 | [diff] [blame] | 32 | |
| 33 | Please send comments and bug reports to python-docs@python.org. |