psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2025-10-31 15:57:31 +03:00

History

Daniele Varrazzo 73265e7ece Refuse connection with server with protocol version 2. This cuts off server whose version is older than 7.4. But enables us to remove large portions of code rarely used and tested (e.g. p2 copy) and will allow us to drop the query we do at each connection to establish the client encoding and the datestyle.		2010-11-16 01:01:32 +00:00
..
src	Refuse connection with server with protocol version 2.	2010-11-16 01:01:32 +00:00
ChangeLog-1.x	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00
COPYING	Changes license to LGPL3 + OpenSSL exception on all source files	2010-02-12 23:34:53 +01:00
COPYING.LESSER	Changes license to LGPL3 + OpenSSL exception on all source files	2010-02-12 23:34:53 +01:00
HACKING	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00
Makefile	Documentation dir reordered.	2010-02-14 16:45:36 +00:00
pep-0249.txt	Added PEP 249 source (.txt).	2005-11-28 03:44:31 +00:00
README	Documentation dir reordered.	2010-02-14 16:45:36 +00:00
SUCCESS	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00

README

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.