[Docutils-checkins] r5387 - trunk/sandbox/py-rest-doc/README

[<gb...@us...>]

Author: gbrandl
Date: 2007-07-22 21:44:42 +0200 (Sun, 22 Jul 2007)
New Revision: 5387

Modified:
   trunk/sandbox/py-rest-doc/README
Log:
Make the patching step explicit in the readme.


Modified: trunk/sandbox/py-rest-doc/README
===================================================================
--- trunk/sandbox/py-rest-doc/README	2007-07-22 18:40:01 UTC (rev 5386)
+++ trunk/sandbox/py-rest-doc/README	2007-07-22 19:44:42 UTC (rev 5387)
@@ -19,18 +19,21 @@
 checkout (you need the 2.6 line, i.e. the trunk) in ~/devel/python and
 this checkout in the current directory.
 
-To convert the LaTeX doc to reST, create a target directory for the
-reST sources and run the converter script::
+To convert the LaTeX doc to reST, you first have to apply the patch in
+``etc/inst.diff`` to the ``inst/inst.tex`` LaTeX file in the Python
+checkout::
 
+   patch -d ~/devel/python/Doc -p0 < etc/inst.diff
+
+Then, create a target directory for the reST sources and run the
+converter script::
+
    mkdir sources
    python convert.py ~/devel/python/Doc sources
 
 This will convert all LaTeX sources to reST files in the ``sources``
 directory.
 
-Note: the ``inst.tex`` document ("Installing Python Modules") is only
-convertable after applying the patch in ``etc/inst.diff``.
-
 The ``sources`` directory contains a ``conf.py`` file which contains
 general configuration for the build process, such as the Python
 version that should be shown, or the date format for "last updated on"