psycopg/psycopg2
1
1
Fork 0
mirror of https://github.com/psycopg/psycopg2.git synced 2025-10-24 20:41:07 +03:00
Code Issues Packages Projects Releases Wiki Activity
7af0bf0b54
psycopg2/doc
History
Daniele Varrazzo 8fed0aa57d Forbid COPY-related methods in green mode. 
With the current implementation, at best they would silently block. They
actually hang everything.

Implementation posponed after some refactoring of the polling system,
because it will be probably possible to provide an implementation for
'poll()' during COPY which is good for both async and green modes.
2010-04-21 15:21:33 +01:00
..
src Forbid COPY-related methods in green mode. 2010-04-21 15:21:33 +01: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.