psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2025-01-31 17:34:08 +03:00

History

Bernhard M. Wiedemann d829a75f2e dont claim copyright for future years otherwise, when building from unchanged source in 2018, it would claim Copyright 2018 which is not true Being able to reproduce identical output from identical input is important to Linux distributions		2016-03-09 16:33:54 +01:00
..
src	dont claim copyright for future years	2016-03-09 16:33:54 +01:00
COPYING.LESSER	Changes license to LGPL3 + OpenSSL exception on all source files	2010-02-12 23:34:53 +01:00
Makefile	Added makefile target to upload docs	2015-05-03 10:30:33 +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
requirements.txt	Use virtualenv as build environment for the docs	2014-08-24 23:11:07 +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``.