psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-10 19:16:34 +03:00

History

Daniele Varrazzo 9154d0920c Changed docs to point to psycopg.org		2019-12-30 18:12:46 +01:00
..
src	Changed docs to point to psycopg.org	2019-12-30 18:12:46 +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	Changed docs to point to psycopg.org	2019-12-30 18:12:46 +01:00
release.rst	Document a release procedure not using initd server	2019-12-30 17:13:37 +01:00
requirements.txt	Blacklist docutils 0.15 to build docs	2019-12-29 23:54:18 +01:00
SUCCESS	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08: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://www.psycopg.org/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.