psycopg2

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

History

Daniele Varrazzo 620f77cb77 Generate text documentation in a single file.		2010-02-14 16:45:31 +00:00
..
_static	Big documentation cleanup.	2010-02-14 00:39:48 +01:00
tools	Generate text documentation in a single file.	2010-02-14 16:45:31 +00:00
advanced.rst	Index and targets for subclassing work again.	2010-02-14 13:23:04 +00:00
ChangeLog-1.x	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00
conf.py	Added function to drop a test table in the doctest.	2010-02-14 13:23:05 +00:00
connection.rst	Drop table moved off the example.	2010-02-14 13:23:05 +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
cursor.rst	The documentation is now mostly doctest-able	2010-02-14 13:23:04 +00:00
dbapi_extension.py	Added ``extension`` directive to mark Psycopg extensions to the DB API.	2010-02-14 00:39:47 +01:00
errorcodes.rst	Added documentation for the errorcodes module.	2010-02-14 00:39:49 +01:00
extensions.rst	The documentation is now mostly doctest-able	2010-02-14 13:23:04 +00:00
extras.rst	Docs cleaned up while still being testable.	2010-02-14 13:23:05 +00:00
HACKING	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00
index.rst	Generate text documentation in a single file.	2010-02-14 16:45:31 +00:00
Makefile	Generate text documentation in a single file.	2010-02-14 16:45:31 +00:00
module.rst	The documentation is now mostly doctest-able	2010-02-14 13:23:04 +00:00
pep-0249.txt	Added PEP 249 source (.txt).	2005-11-28 03:44:31 +00:00
README	Documentation generated in 'doc/html/' instead of 'doc/_build/html/'	2010-02-14 01:10:37 +00:00
sql_role.py	Added docutils SQL role.	2010-02-14 00:39:48 +01:00
SUCCESS	Initial psycopg 2 import after SVN crash.	2004-10-19 03:17:12 +00:00
tz.rst	Added other info about tz module.	2010-02-14 00:39:48 +01:00
usage.rst	The documentation is now mostly doctest-able	2010-02-14 13:23:04 +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

- Checkout the psycopg branch containing the documentation::

    (pd)~/pd$ git clone git://github.com/dvarrazzo/psycopg2.git 
    (pd)~/pd$ cd psycopg2/
    (pd)~/pd/psycopg2$ git branch 
    * docs

- 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 html
    Running Sphinx v0.6.4
    ...

You should have the rendered documentation in ``./html`` now.