psycopg2/doc
2018-11-07 14:15:29 +01:00
..
src Merge branch 'master' into feature-expose-pgconn 2018-11-07 14:15:29 +01:00
COPYING.LESSER Trim trailing whitespace from all files throughout project 2017-12-01 21:42:14 -08:00
Makefile Allow SPHINXBUILD on command line 2018-10-07 13:55:11 +02:00
pep-0249.txt Trim trailing whitespace from all files throughout project 2017-12-01 21:42:14 -08: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:22:37 +01:00
requirements.txt Sphinx version do build docs updated to 1.6 2017-10-18 21:56:48 +01:00
SUCCESS Trim trailing whitespace from all files throughout project 2017-12-01 21:42:14 -08:00

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``.