psycopg2/doc
2015-02-08 02:21:22 +00:00
..
src Document that LO64 is only available on Py 64 builds 2015-02-08 02:21:22 +00:00
COPYING.LESSER Changes license to LGPL3 + OpenSSL exception on all source files 2010-02-12 23:34:53 +01:00
Makefile Use virtualenv as build environment for the docs 2014-08-24 23:11:07 +01:00
pep-0249.txt Fix multiple misspellings 2013-04-26 09:59:40 +01:00
README Documentation dir reordered. 2010-02-14 16:45:36 +00:00
requirements.txt Use virtualenv as build environment for the docs 2014-08-24 23:11:07 +01:00
SUCCESS Fix multiple misspellings 2013-04-26 09:59:40 +01:00

How to build psycopg documentation
----------------------------------

- Install Sphinx, maybe in a virtualenv. Tested with Sphinx 0.6.4::

    ~$ virtualenv pd
    New python executable in pd/bin/python
    Installing setuptools............done.
    ~$ cd pd
    ~/pd$ source bin/activate
    (pd)~/pd$ 

- Install Sphinx in the env::

    (pd)~/pd$ easy_install sphinx
    Searching for sphinx
    Reading http://pypi.python.org/simple/sphinx/
    Reading http://sphinx.pocoo.org/
    Best match: Sphinx 0.6.4
    ...
    Finished processing dependencies for sphinx

- Build psycopg2 and ensure the package can be imported (it will be used for
  reading the version number, autodocs etc.)::

    (pd)~/pd/psycopg2$ python setup.py build
    (pd)~/pd/psycopg2$ python setup.py install
    running install
    ...
    creating ~/pd/lib/python2.6/site-packages/psycopg2
    ...

- Move to the ``doc`` dir and run ``make`` from there::

    (pd)~/pd/psycopg2$ cd doc/
    (pd)~/pd/psycopg2/doc$ make
    Running Sphinx v0.6.4
    ...

You should have the rendered documentation in ``./html`` and the text file
``psycopg2.txt`` now.