psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-27 03:13:43 +03:00

History

Daniele Varrazzo 699a4bcb90 Declare Python 3.7 supported I had problems running the test on travis in a way that make the long-in-the-tooth Python 3.2 happy, however it was tested in the test_i686 branch and it works fine.		2018-11-08 17:37:47 +00:00
..
src	Declare Python 3.7 supported	2018-11-08 17:37:47 +00:00
COPYING.LESSER	Changes license to LGPL3 + OpenSSL exception on all source files	2010-02-12 23:34:53 +01:00
Makefile	Command to upload docs on pythonhosted dropped altogether	2018-02-25 18:13:29 +00: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	Update all pypi.python.org URLs to pypi.org	2018-05-20 17:25:28 +01: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``.