psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-22 08:56:34 +03:00

History

Jon Dufresne 4e13acdc88 Add Python 3.8 to the test matrix Python 3.8 was released on October 14th, 2019. - Added 'Programming Language :: Python :: 3.8' trove classifier. - Added 'py38' to the tox test matrix. - Added 'python: 3.8' to the Travis test matrix. - Removed 'dist: xenial' from Travis configuration; it is now the default. - Removed 'dist: trusty' from Travis configuration; it is not longer necessary. - Removed 'sudo' from Travis configuration; it is deprecated. https://docs.python.org/3.8/whatsnew/3.8.html		2019-10-18 18:29:59 -07:00
..
src	Add Python 3.8 to the test matrix	2019-10-18 18:29:59 -07:00
.gitignore	Added table of sqlstate exceptions in the docs	2019-02-17 01:55:14 +01:00
COPYING.LESSER	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
Makefile	Allow building docs with Python 3	2019-02-17 01:36:36 +00:00
pep-0249.txt	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
README.rst	Dropped text docs generation	2019-02-17 00:58:27 +00:00
release.rst	Update all pypi.python.org URLs to pypi.org	2018-05-20 17:22:37 +01: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

You should find the rendered documentation in the ``html`` directory.