psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-10 19:16:34 +03:00

History

Omer Katz a1fd2da1dc Mention the CFFI port to Psycopg2 in documentation. The CFFI port works much better on PyPy and has been used in production before. The documentation mentioned the Ctypes port but not the CFFI port. I added it to the documentation.		2019-10-23 12:05:33 +03:00
..
src	Mention the CFFI port to Psycopg2 in documentation.	2019-10-23 12:05:33 +03:00
.gitignore	Added table of sqlstate exceptions in the docs	2019-02-17 01:55:14 +01:00
COPYING.LESSER	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
Makefile	Allow building docs with Python 3	2019-02-17 01:36:36 +00:00
pep-0249.txt	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
README.rst	Dropped text docs generation	2019-02-17 00:58:27 +00:00
release.rst	Use travis test config variable 0/1 instead of blank strings	2019-10-19 15:18:38 +02:00
requirements.txt
SUCCESS	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08: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

You should find the rendered documentation in the ``html`` directory.