Skip to content

Commit 8e51820

Browse files
author
James William Pye
committed
Minor updates and add bin to contents.
1 parent 917f88d commit 8e51820

5 files changed

Lines changed: 19 additions & 16 deletions

File tree

postgresql/documentation/admin.py

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,33 +33,31 @@
3333
3434
By default, a Python installation on Windows cannot build extension modules.
3535
py-postgresql provides optimizations for various key points, but can be
36-
installed and used without them. When an installation is performed on 'win32'
37-
systems, extension modules are *not* built by default.
36+
installed and used without them. When a source installation is performed on
37+
'win32' systems, extension modules are *not* built by default.
3838
3939
In order to enable the compilation of extensions, set the environment variable
40-
``PY_BUILD_EXTENSIONS`` to a non-empty string before executing the ``setup.py``
40+
``PY_BUILD_EXTENSIONS`` to '1' before executing the ``setup.py``
4141
script::
4242
4343
C:\-> setenv PY_BUILD_EXTENSIONS 1
44-
C:\-> python3 setup.py install
44+
C:\-> c:\python30\python setup.py install
4545
46-
Or if mingw32 installed::
46+
Or more likely, compile using mingw32::
4747
4848
C:\-> setenv PY_BUILD_EXTENSIONS 1
49-
C:\-> python3 setup.py build_ext --compiler=mingw32
50-
C:\-> python3 setup.py install
49+
C:\-> c:\python30\python setup.py build_ext --compiler=mingw32
50+
C:\-> c:\python30\python setup.py install
5151
5252
5353
Environment
5454
-----------
5555
5656
py-postgresql is not included with the PostgreSQL distribution, so it's
5757
impossible for certain defaults to be filled in in a way that's consistent with
58-
bundled applications.
59-
60-
``PGINSTALLATION``
61-
The default installation to use and reference when collecting client
62-
parameters or managing clusters.
58+
bundled applications. ``PGINSTALLATION`` can be used to direct the Python
59+
libraries at the appropriate PostgreSQL installation. This should be set to the
60+
absolute path of the ``pg_config`` executable.
6361
"""
6462

6563
__docformat__ = 'reStructuredText'

postgresql/documentation/gotchas.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# copyright 2009, James William Pye
33
# http://python.projects.postgresql.org
44
##
5-
r"""
6-
py-postgresql gotchas
7-
=====================
5+
r'''
6+
Gotchas
7+
=======
88
99
It is recognized that decisions were made that may not always be ideal for a
1010
given user. In order to highlight those potential issues and hopefully bring
@@ -57,7 +57,7 @@
5757
5858
The driver enables standard compliant strings. Stop using non-standard features.
5959
;)
60-
"""
60+
'''
6161

6262
__docformat__ = 'reStructuredText'
6363
if __name__ == '__main__':

postgresql/documentation/index.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@
2626
Client Parameters
2727
`postgresql.documentation.clientparameters`
2828
29+
Console Scripts
30+
`postgresql.documentation.bin`
31+
2932
Gotchas
3033
`postgresql.documentation.gotchas`
3134

sphinx-src/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,5 @@ dump: mkdirs
7878
env PYTHONPATH=.. python -m postgresql.documentation.admin dump >admin.txt
7979
env PYTHONPATH=.. python -m postgresql.documentation.driver dump >driver.txt
8080
env PYTHONPATH=.. python -m postgresql.documentation.clientparameters dump >clientparameters.txt
81+
env PYTHONPATH=.. python -m postgresql.documentation.bin dump >bin.txt
8182
env PYTHONPATH=.. python -m postgresql.documentation.gotchas dump >gotchas.txt

sphinx-src/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ accessing a PostgreSQL database.
1414
admin
1515
driver
1616
clientparameters
17+
bin
1718
gotchas
1819

1920
------------------

0 commit comments

Comments
 (0)