[Python-checkins] python/dist/src/Doc/doc doc.tex, 1.67.2.2, 1.67.2.3
jhylton@users.sourceforge.net
jhylton at users.sourceforge.net
Sun Oct 16 07:24:30 CEST 2005
- Previous message: [Python-checkins] python/dist/src/Doc/commontex license.tex, 1.6.4.1, 1.6.4.2
- Next message: [Python-checkins] python/dist/src/Doc/api abstract.tex, 1.17.2.2, 1.17.2.3 concrete.tex, 1.17.2.2, 1.17.2.3 init.tex, 1.3.2.2, 1.3.2.3 newtypes.tex, 1.13.2.2, 1.13.2.3 refcounts.dat, 1.43.2.1, 1.43.2.2 utilities.tex, 1.5.2.2, 1.5.2.3
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
Update of /cvsroot/python/python/dist/src/Doc/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27718/Doc/doc
Modified Files:
Tag: ast-branch
doc.tex
Log Message:
Merge head to branch (for the last time)
Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.67.2.2
retrieving revision 1.67.2.3
diff -u -d -r1.67.2.2 -r1.67.2.3
--- doc.tex 7 Jan 2005 06:56:54 -0000 1.67.2.2
+++ doc.tex 16 Oct 2005 05:23:57 -0000 1.67.2.3
@@ -617,7 +617,7 @@
Documentation for a ``simple'' macro. Simple macros are macros
which are used for code expansion, but which do not take
arguments so cannot be described as functions. This is not to
- be used for simple constant definitions. Examples of it's use
+ be used for simple constant definitions. Examples of its use
in the Python documentation include
\csimplemacro{PyObject_HEAD} and
\csimplemacro{Py_BEGIN_ALLOW_THREADS}.
@@ -812,7 +812,7 @@
The name of a ``simple'' macro. Simple macros are macros
which are used for code expansion, but which do not take
arguments so cannot be described as functions. This is not to
- be used for simple constant definitions. Examples of it's use
+ be used for simple constant definitions. Examples of its use
in the Python documentation include
\csimplemacro{PyObject_HEAD} and
\csimplemacro{Py_BEGIN_ALLOW_THREADS}.
@@ -1134,9 +1134,9 @@
\subsection{Module-specific Markup \label{module-markup}}
The markup described in this section is used to provide information
- about a module being documented. A typical use of this markup
- appears at the top of the section used to document a module. A
- typical example might look like this:
+ about a module being documented. Each module should be documented
+ in its own \macro{section}. A typical use of this markup
+ appears at the top of that section and might look like this:
\begin{verbatim}
\section{\module{spam} ---
@@ -1878,31 +1878,42 @@
\subsection{Working on Cygwin \label{cygwin}}
Installing the required tools under Cygwin under Cygwin can be a
- little tedious, if only because many packages are more difficult
- to install under Cygwin.
+ little tedious. Most of the required packages can be installed
+ using Cygwin's graphical installer, while netpbm and \LaTeX2HTML
+ must be installed from source.
+
+ Start with a reasonably modern version of Cygwin. If you haven't
+ upgraded for a few years, now would be a good time.
Using the Cygwin installer, make sure your Cygwin installation
includes Perl, Python, and the \TeX{} packages. Perl and Python
- are located under \menuselection{Interpreters} in the installer.
- The \TeX{} packages are located in the \menuselection{Text}
- section; installing the \code{tetex-beta}, \code{texmf},
- \code{texmf-base}, and \code{texmf-extra} ensures that all the
- required packages are available. (There may be a more minimal
- set, but I've not spent time trying to minimize the installation.)
+ are located under the \menuselection{Interpreters} heading. The
+ \TeX{} packages are located under the \menuselection{Text}
+ heading, and are named \code{tetex-*}. To ensure that all
+ required packages are available, install every \code{tetex}
+ package, except \code{tetex-x11}. (There may be a more minimal
+ set, but I've not spent time trying to minimize the installation.)
The netpbm package is used by \LaTeX2HTML, and \emph{must} be
installed before \LaTeX2HTML can be successfully installed, even
- though they will never be used for most Python documentation.
- References to download locations are located in the \ulink{netpbm
- README}{http://netpbm.sourceforge.net/README}. Install according
- to the instructions.
+ though its features will not be used for most Python
+ documentation. References to download locations are located in
+ the \ulink{netpbm README}{http://netpbm.sourceforge.net/README}.
+ Install from the latest stable source distribution according to
+ the instructions. (Note that binary packages of netpbm are
+ sometimes available, but these may not work correctly with
+ \LaTeX2HTML.)
\LaTeX2HTML can be installed from the source archive, but only
- after munging one of the files in the distribution. Edit the file
- \file{L2hos.pm} in the top level of the unpacked distribution;
- near the bottom of the file, change the text
- \code{\$\textasciicircum{}O} with the text \code{'unix'}. Proceed
- using this command to build and install the software:
+ after munging one of the files in the distribution. Download the
+ source archive from the \LaTeX2HTML website
+ \url{http://www.latex2html.org/} (or one of the many alternate
+ sites) and unpack it to a build directory. In the top level of
+ this build directory there will be a file named \file{L2hos.pm}.
+ Open \file{L2hos.pm} in an editor, and near the bottom of the file
+ replace the text \code{\$\textasciicircum{}O} with the text
+ \code{'unix'}. Proceed using this command to build and install
+ the software:
\begin{verbatim}
% ./configure && make install
- Previous message: [Python-checkins] python/dist/src/Doc/commontex license.tex, 1.6.4.1, 1.6.4.2
- Next message: [Python-checkins] python/dist/src/Doc/api abstract.tex, 1.17.2.2, 1.17.2.3 concrete.tex, 1.17.2.2, 1.17.2.3 init.tex, 1.3.2.2, 1.3.2.3 newtypes.tex, 1.13.2.2, 1.13.2.3 refcounts.dat, 1.43.2.1, 1.43.2.2 utilities.tex, 1.5.2.2, 1.5.2.3
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
More information about the Python-checkins
mailing list