psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-09-20 18:58:55 +03:00

History

Sergey Golitsynskiy 359679b136 Fix typo in sample code: psycopg >> psycopg2		2021-05-23 11:56:22 +02:00
..
src	Fix typo in sample code: psycopg >> psycopg2	2021-05-23 11:56:22 +02: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	Suggest how to auto-generate tag name in release doc	2020-09-06 17:24:04 +01: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.