psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-26 10:53:44 +03:00

History

Jon Dufresne f5703dc3e5 Use builtin function next() throughout project Available since Python 2.6. Use of .next() is deprecated and not supported in Python 3. Forward compatible with modern Python. https://docs.python.org/2/library/functions.html#next		2017-12-01 19:57:37 -08:00
..
src	Use builtin function next() throughout project	2017-12-01 19:57:37 -08:00
COPYING.LESSER	Changes license to LGPL3 + OpenSSL exception on all source files	2010-02-12 23:34:53 +01:00
Makefile	Disable uploading docs on pythonhosted	2017-08-23 13:42:49 +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
release.rst	Improved notes to release psycopg packages	2017-03-13 16:50:57 +00:00
requirements.txt	Sphinx version do build docs updated to 1.6	2017-10-18 21:56:48 +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``.