psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2025-10-24 12:31:05 +03:00

History

Jon Dufresne 389f6c08d9 Avoid installing tests to site-packages For library end users, there is no need to install tests alongside the package itself. This keeps the tests available for development without adding extra packages to user's site-packages directory. Reduces the size of the installed package. Avoids accidental execution of test code by an installed package.		2017-12-10 10:55:58 -08:00
..
src	Avoid installing tests to site-packages	2017-12-10 10:55:58 -08:00
COPYING.LESSER	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
Makefile	Disable uploading docs on pythonhosted	2017-08-23 13:42:49 +01: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	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08: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

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