summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorgeorg.brandl <devnull@localhost>2007-08-04 22:51:34 +0000
committergeorg.brandl <devnull@localhost>2007-08-04 22:51:34 +0000
commit9b381201ab4e44d01ae355697f5fdffb6ffc904c (patch)
tree25cf371656ce2efd463efc98f2f29730d47b3ae8 /README
parentaa89b3b1f2c10710402081d1f49d9c920569597c (diff)
downloadsphinx-9b381201ab4e44d01ae355697f5fdffb6ffc904c.tar.gz
Update readme.
Diffstat (limited to 'README')
-rw-r--r--README11
1 files changed, 9 insertions, 2 deletions
diff --git a/README b/README
index ef57da8f..cc8b4ed9 100644
--- a/README
+++ b/README
@@ -15,6 +15,13 @@ If you want code highlighting, you need Pygments >= 0.8, easily
installable from PyPI. Jinja, the template engine, is included as a
SVN external.
+
+Converting the LaTeX sources
+----------------------------
+
+**This paragraph is obsolete.** The conversion has been done, and reST docs
+trees are now maintained for 2.6 and 3.0 branches.
+
For the rest of this document, let's assume that you have a Python
checkout (you need the 2.6 line, i.e. the trunk -- the SVN URL for readonly
access is http://svn.python.org/projects/python/trunk) in ~/devel/python
@@ -47,7 +54,7 @@ Building the HTML version
Then, create a target directory and run ::
mkdir build-html
- python sphinx-build.py -b html sources build-html
+ python sphinx-build.py -b html Doc-26 build-html
This will create HTML files in the ``build-html`` directory.
@@ -64,7 +71,7 @@ Running the online (web) version
First, you need to build the source with the "web" builder::
mkdir build-web
- python sphinx-build.py -b web sources build-web
+ python sphinx-build.py -b web Doc-26 build-web
This will create files with pickled contents for the web application
in the target directory.