psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-25 18:33:44 +03:00

History

Oleksandr Shulgin e32e1b834e Add support for streaming replication protocol Introduce ReplicationConnection and ReplicationCursor classes, that incapsulate initiation of special type of PostgreSQL connection and handling of special replication commands only available in this special connection mode. The handling of stream of replication data from the server is modelled largely after the existing support for "COPY table TO file" command and pg_recvlogical tool supplied with PostgreSQL (though, it can also be used for physical replication.)		2015-06-01 11:45:04 +02:00
..
src	Add support for streaming replication protocol	2015-06-01 11:45:04 +02:00
COPYING.LESSER	Changes license to LGPL3 + OpenSSL exception on all source files	2010-02-12 23:34:53 +01:00
Makefile	Added makefile target to upload docs	2015-05-03 10:30:33 +01:00
pep-0249.txt	Fix multiple misspellings	2013-04-26 09:59:40 +01:00
README.rst	Docs build process and docs cleaned up	2015-04-28 09:32:58 +01: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

README.rst

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

Building the documentation usually requires building the library too for
introspection, so you will need the same prerequisites_.  The only extra
prerequisite is virtualenv_: the packages needed to build the docs will be
installed when building the env.

.. _prerequisites: http://initd.org/psycopg/docs/install.html#install-from-source
.. _virtualenv: https://virtualenv.pypa.io/en/latest/

Build the env once with::

    make env

Then you can build the documentation with::

    make

Or the single targets::

    make html
    make text

You should find the rendered documentation in the ``html`` dir and the text
file ``psycopg2.txt``.