psycopg2/doc
2023-04-23 22:47:26 +02:00
..
src fix typo in Usage.html page in documentation 2023-04-23 22:47:26 +02:00
.gitignore Dropped customized doc template 2020-01-27 04:32:31 +00:00
COPYING.LESSER docs: use https url in license file 2023-02-25 15:36:35 +01:00
Makefile docs: drop use of print statement, use the print() function instead 2023-04-17 20:07:17 +02: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 ci: drop github download script 2023-04-03 05:10:36 +02: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 chore: upgrade docs build dependencies 2023-04-17 20:11:47 +02:00
SUCCESS Trim trailing whitespace from all files throughout project 2017-12-01 21:42:14 -08:00

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.