psycopg2/doc/README.rst

21 lines
628 B
ReStructuredText
Raw Normal View History

2015-04-28 11:30:59 +03: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.
2019-12-31 15:09:13 +03:00
.. _prerequisites: https://www.psycopg.org/docs/install.html#install-from-source
2015-04-28 11:30:59 +03:00
.. _virtualenv: https://virtualenv.pypa.io/en/latest/
Build the env once with::
make env
Then you can build the documentation with::
make
2019-02-17 03:48:33 +03:00
You should find the rendered documentation in the ``html`` directory.