psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-09-21 03:08:57 +03:00

History

Edan Schwartz ed3d44562d Move pyscopg-binary install docs to "quick start" section This is the fastest way for most folks to get up-and-running with psycopg. We've seen a lot of noise in the GH issues with people failng to install the non-binary version. Hopefully this will make life easier for people new to psycopg/python. See https://github.com/psycopg/psycopg2/issues/1085#issuecomment-659028139		2020-08-07 15:05:45 -05:00
..
src	Move pyscopg-binary install docs to "quick start" section	2020-08-07 15:05:45 -05:00
.gitignore	Dropped customized doc template	2020-01-27 04:32:31 +00:00
COPYING.LESSER	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
Makefile	Trigger docs rebuild on push	2020-01-25 19:51:21 +00:00
pep-0249.txt	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
README.rst	Website on https	2019-12-31 13:09:13 +01:00
release.rst	Upload on https now	2020-01-27 02:58:58 +00:00
requirements.txt	Use a responsive theme for docs	2020-01-18 23:56:44 +00: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: https://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.