summaryrefslogtreecommitdiff
path: root/doc/README
diff options
context:
space:
mode:
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>2010-02-14 16:11:01 +0000
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>2010-02-14 16:45:36 +0000
commitb744c92f58ab3dfc65d51dfe61acc11427a192dd (patch)
tree04d4f89e839fde6384371589dabb6aae01e773d8 /doc/README
parent620f77cb77304e1b03d311204e5f942109b1a5f4 (diff)
downloadpsycopg2-b744c92f58ab3dfc65d51dfe61acc11427a192dd.tar.gz
Documentation dir reordered.
Diffstat (limited to 'doc/README')
-rw-r--r--doc/README12
1 files changed, 3 insertions, 9 deletions
diff --git a/doc/README b/doc/README
index 3936011..f74f7d9 100644
--- a/doc/README
+++ b/doc/README
@@ -20,13 +20,6 @@ How to build psycopg documentation
...
Finished processing dependencies for sphinx
-- Checkout the psycopg branch containing the documentation::
-
- (pd)~/pd$ git clone git://github.com/dvarrazzo/psycopg2.git
- (pd)~/pd$ cd psycopg2/
- (pd)~/pd/psycopg2$ git branch
- * docs
-
- Build psycopg2 and ensure the package can be imported (it will be used for
reading the version number, autodocs etc.)::
@@ -40,9 +33,10 @@ How to build psycopg documentation
- Move to the ``doc`` dir and run ``make`` from there::
(pd)~/pd/psycopg2$ cd doc/
- (pd)~/pd/psycopg2/doc$ make html
+ (pd)~/pd/psycopg2/doc$ make
Running Sphinx v0.6.4
...
-You should have the rendered documentation in ``./html`` now.
+You should have the rendered documentation in ``./html`` and the text file
+``psycopg2.txt`` now.