psycopg/psycopg2
1
1
Fork 0
mirror of https://github.com/psycopg/psycopg2.git synced 2024-09-21 03:08:57 +03:00
Code Issues Packages Projects Releases Wiki Activity
29a65f756c
psycopg2/doc
History
Daniele Varrazzo 29a65f756c chore: upgrade error codes to PostgreSQL 15
2022-10-06 02:26:09 +01:00
..
src chore: upgrade error codes to PostgreSQL 15 2022-10-06 02:26:09 +01: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 Fix building docs for the website 2021-06-17 03:54:14 +01: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 Don't build .exe packages anymore 2021-06-30 14:52:27 +01:00
requirements.in Use pip-tools to create the requirement file to build the docs 2022-03-26 02:45:40 +01:00
requirements.txt Use pip-tools to create the requirement file to build the docs 2022-03-26 02:45:40 +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: 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.