cpython

mirror of https://github.com/python/cpython.git synced 2025-07-24 11:44:31 +00:00

History

Fred Drake 080c1b5af6 bwrite(), ewrite(): Helpers for diagnostic output; essentially the same as sys.stderr.write(), but bwrite() will make it bold if stderr is a tty (for visibility). Use these everywhere instead of accessing sys.stderr.write() directly. find_all_child_elements(): Find all elements by type name that are immediate children of another. cleanup_synopses(): Receive both the document and fragment objects as parameters; if only the document is passed, synopsis information is never found since it's in the fragment! build_para(): Add a chunk of code to ensure that a newline always follows the </para> end-tag. Not really important, but makes presentation consistent for authoring/ maintenance. fixup_bifuncindexes_chunk(): Use find_all_child_elements() instead of find_all_elements() so we don't work with too many levels at once; that could cause DOM exceptions with the <elem>.removeChild() method.		1999-08-02 14:46:15 +00:00
..
conversion.xml	A few small improvements to the conversion.	1999-08-02 14:32:11 +00:00
docfixer.py	bwrite(), ewrite(): Helpers for diagnostic output; essentially the	1999-08-02 14:46:15 +00:00
esis2sgml.py	Some minor cleanup.	1999-07-29 22:03:52 +00:00
esistools.py	Use the (new) buildFragment() method of the EsisBuilder rather than	1999-07-29 22:13:31 +00:00
fixgenents.sh	This doesn't need to do nearly as much for the new conversion, so	1999-08-02 14:32:46 +00:00
latex2esis.py	Mostly minor changes.	1999-08-02 14:35:25 +00:00
make.rules	Minor updates.	1999-07-29 22:14:09 +00:00
Makefile	Make the default target xml instead of sgml.	1999-07-22 13:57:12 +00:00
README	Minor update.	1999-07-29 22:01:39 +00:00

README

These scripts and Makefile fragment are used to convert the Python
documentation in LaTeX format to SGML or XML.  Though I originally
thought that the XML was unlikely to be used, tool support for XML
is increasing quickly enough that it may well be the final format.
(It is the default output format when using the makefiles included
here.)

This material is preliminary and incomplete.  The XML omnibus package
developed by the Python XML-SIG is required; specifically, the version
available in the public CVS repository.  See
http://www.python.org/sigs/xml-sig/ for more information on the
package.

To convert all documents to SGML:

	cd Doc/
	make -f tools/sgmlconv/Makefile sgml

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).
This is true regardless of whether you build SGML or XML first.

Please send comments and bug reports to python-docs@python.org.