psycopg2/doc
2019-06-21 11:26:47 +01:00
..
src Fix typo: "the the" 2019-06-21 11:26:47 +01: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 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

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