mirror of
https://github.com/psycopg/psycopg2.git
synced 2024-11-10 19:16:34 +03:00
.. | ||
_static | ||
advanced.rst | ||
ChangeLog-1.x | ||
conf.py | ||
connection.rst | ||
COPYING | ||
COPYING.LESSER | ||
cursor.rst | ||
dbapi_extension.py | ||
errorcodes.rst | ||
extensions.rst | ||
extras.rst | ||
HACKING | ||
index.rst | ||
Makefile | ||
module.rst | ||
pep-0249.txt | ||
README | ||
sql_role.py | ||
SUCCESS | ||
tz.rst | ||
usage.rst |
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.