mirror of
https://github.com/psycopg/psycopg2.git
synced 2024-11-16 05:56:34 +03:00
27 lines
712 B
ReStructuredText
27 lines
712 B
ReStructuredText
|
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
|
||
|
|
|
||
|
|
Or the single targets::
|
||
|
|
|
||
|
|
make html
|
||
|
|
make text
|
||
|
|
|
||
|
|
You should find the rendered documentation in the ``html`` dir and the text
|
||
|
|
file ``psycopg2.txt``.
|