psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-09-21 03:08:57 +03:00

History

Daniele Varrazzo e8db9954d1 Improvements to the connect() docs - links updated to the current PG docs, which include the syntax as url and lists the parameters in a separate chapter - more evident links to the PG docs - mutually exclusive use of dsn and **kwargs specified See ticket #143		2013-01-09 12:56:06 +00:00
..
src	Improvements to the connect() docs	2013-01-09 12:56:06 +00:00
ChangeLog-1.x	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00
COPYING	Changes license to LGPL3 + OpenSSL exception on all source files	2010-02-12 23:34:53 +01:00
COPYING.LESSER	Changes license to LGPL3 + OpenSSL exception on all source files	2010-02-12 23:34:53 +01:00
HACKING	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00
Makefile	Documentation dir reordered.	2010-02-14 16:45:36 +00:00
pep-0249.txt	Added PEP 249 source (.txt).	2005-11-28 03:44:31 +00:00
README	Documentation dir reordered.	2010-02-14 16:45:36 +00:00
SUCCESS	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00

README

How to build psycopg documentation
----------------------------------

- Install Sphinx, maybe in a virtualenv. Tested with Sphinx 0.6.4::

    ~$ virtualenv pd
    New python executable in pd/bin/python
    Installing setuptools............done.
    ~$ cd pd
    ~/pd$ source bin/activate
    (pd)~/pd$ 

- Install Sphinx in the env::

    (pd)~/pd$ easy_install sphinx
    Searching for sphinx
    Reading http://pypi.python.org/simple/sphinx/
    Reading http://sphinx.pocoo.org/
    Best match: Sphinx 0.6.4
    ...
    Finished processing dependencies for sphinx

- Build psycopg2 and ensure the package can be imported (it will be used for
  reading the version number, autodocs etc.)::

    (pd)~/pd/psycopg2$ python setup.py build
    (pd)~/pd/psycopg2$ python setup.py install
    running install
    ...
    creating ~/pd/lib/python2.6/site-packages/psycopg2
    ...

- Move to the ``doc`` dir and run ``make`` from there::

    (pd)~/pd/psycopg2$ cd doc/
    (pd)~/pd/psycopg2/doc$ make
    Running Sphinx v0.6.4
    ...

You should have the rendered documentation in ``./html`` and the text file
``psycopg2.txt`` now.