mirror of
https://github.com/psycopg/psycopg2.git
synced 2026-01-26 00:53:47 +03:00
|
|
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| COPYING.LESSER | ||
| Makefile | ||
| pep-0249.txt | ||
| README.rst | ||
| release.rst | ||
| requirements.in | ||
| requirements.txt | ||
| SUCCESS | ||
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.