[Python-checkins] python/dist/src/Doc/doc doc.tex,1.87,1.88

fdrake at users.sourceforge.net fdrake at users.sourceforge.net
Mon Oct 18 23:30:42 CEST 2004

Update of /cvsroot/python/python/dist/src/Doc/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11494

Modified Files:
Log Message:
made it clear that this isn't a complete reference to
LaTeX-as-used-in-Python-documentation, and added some notes about
what's missing

Index: doc.tex
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.87
retrieving revision 1.88
diff -u -d -r1.87 -r1.88
--- doc.tex	1 Aug 2004 22:36:40 -0000	1.87
+++ doc.tex	18 Oct 2004 21:30:40 -0000	1.88
@@ -214,7 +214,11 @@
   This section is a brief introduction to \LaTeX{} concepts and
   syntax, to provide authors enough information to author documents
-  productively without having to become ``\TeX{}nicians.''
+  productively without having to become ``\TeX{}nicians.''  This does
+  not teach everything needed to know about writing \LaTeX{} for
+  Python documentation; many of the standard ``environments'' are not
+  described here (though you will learn how to mark something as an
+  environment).
   Perhaps the most important concept to keep in mind while marking up
   Python documentation is that while \TeX{} is unstructured, \LaTeX{} was
@@ -445,6 +449,34 @@
+  \subsection{Common Environments \label{latex-environments}}
+    \LaTeX{} provides a variety of environments even without the
+    additional markup provided by the Python-specific document classes
+    introducted in the next section.  The following environments are
+    provided as part of standard \LaTeX{} and are being used in the
+    standard Python documentation; descriptions will be added here as
+    time allows.
 \section{Document Classes \label{classes}}
   Two \LaTeX{} document classes are defined specifically for use with
@@ -480,7 +512,8 @@
   The Python document classes define a lot of new environments and
   macros.  This section contains the reference material for these
-  facilities.
+  facilities.  Documentation for ``standard'' \LaTeX{} constructs is
+  not included here, though they are used in the Python documentation.
   \subsection{Markup for the Preamble \label{preamble-info}}

More information about the Python-checkins mailing list