mirror of
https://github.com/psycopg/psycopg2.git
synced 2024-12-04 14:43:44 +03:00
43 lines
1.1 KiB
Plaintext
43 lines
1.1 KiB
Plaintext
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.
|
|
|