mirror of
https://github.com/psycopg/psycopg2.git
synced 2024-09-21 03:08:57 +03:00
4f1505857b
Every point has an example and all the example show wrong/correct. Nice rhythm. Among the improvements, added point saying explicitly "thou shall not quote placeholders". Quoted placeholders will just fail except in the most contrived cases (a statement raising an exception with all the strings except with the attack ones...), and an example in the following section explicitly notes "no quotes", but apparenty someone still thinks this is not documented enough? (see issue #611) so let's just write it plain and clear into the list of commandments. |
||
|---|---|---|
| .. | ||
| src | ||
| COPYING.LESSER | ||
| Makefile | ||
| pep-0249.txt | ||
| README.rst | ||
| release.rst | ||
| 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: 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``.