psycopg/psycopg2
1
1
Fork 0
mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-24 18:03:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
2833d4f5ff
psycopg2/doc
History
Daniele Varrazzo c076fc3a26 The wait_select callback can cancel a query using Ctrl-C 
Fixes #333.
2015-10-01 15:27:31 +01:00
..
src The wait_select callback can cancel a query using Ctrl-C 2015-10-01 15:27:31 +01: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:25:51 +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:30:59 +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``.