Skip to content

Commit 918e641

Browse files
author
James William Pye
committed
Update documentation. Sigh.
1 parent cc5fdd2 commit 918e641

36 files changed

+158
-150
lines changed

‎postgresql/documentation/changes-v1.0.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Changes in v1.0
66

77
* Fix usage of weakrefs for statement/cursor GC. (Elvis Pranskevichus)
88
(Fixes mysterious DuplicateCursorError exceptions)
9-
* Add support for binary inet/cidr/macaddr types for use with arrays and composites. (Matthew Grant)
9+
* Add support for binary inet/cidr/macaddr types for use with arrays and composites. (Matthew Grant & Barry Grussling)
1010
* Add support for (un)pickling postgresql.types.Array objects. (Elvis Pranskevichus)
1111
* Alter how changes are represented in documentation to simplify merging.
1212

‎postgresql/documentation/html/_sources/changes-v1.0.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Changes in v1.0
44
1.0.4 in development
55
--------------------
66

7+
* Fix usage of weakrefs for statement/cursor GC. (Elvis Pranskevichus)
8+
(Fixes mysterious DuplicateCursorError exceptions)
9+
* Add support for binary inet/cidr/macaddr types for use with arrays and composites. (Matthew Grant & Barry Grussling)
10+
* Add support for (un)pickling postgresql.types.Array objects. (Elvis Pranskevichus)
711
* Alter how changes are represented in documentation to simplify merging.
812

913
1.0.3 released on 2011-09-24

‎postgresql/documentation/html/_static/basic.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,11 @@ div.sphinxsidebar input {
7979
font-size: 1em;
8080
}
8181

82-
div.sphinxsidebar input[type="text"] {
82+
div.sphinxsidebar #searchbox input[type="text"] {
8383
width: 170px;
8484
}
8585

86-
div.sphinxsidebar input[type="submit"] {
86+
div.sphinxsidebar #searchbox input[type="submit"] {
8787
width: 30px;
8888
}
8989

‎postgresql/documentation/html/_static/doctools.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* doctools.js
33
* ~~~~~~~~~~~
44
*
5-
* Sphinx JavaScript utilties for all documentation.
5+
* Sphinx JavaScript utilities for all documentation.
66
*
77
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
@@ -185,9 +185,9 @@ var Documentation = {
185185
body.highlightText(this.toLowerCase(), 'highlighted');
186186
});
187187
}, 10);
188-
$('<li class="highlight-link"><a href="javascript:Documentation.' +
189-
'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>')
190-
.appendTo($('.sidebar .this-page-menu'));
188+
$('<p class="highlight-link"><a href="javascript:Documentation.' +
189+
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
190+
.appendTo($('#searchbox'));
191191
}
192192
},
193193

@@ -213,7 +213,7 @@ var Documentation = {
213213
* helper function to hide the search marks again
214214
*/
215215
hideSearchWords : function() {
216-
$('.sidebar .this-page-menu li.highlight-link').fadeOut(300);
216+
$('#searchbox .highlight-link').fadeOut(300);
217217
$('span.highlighted').removeClass('highlighted');
218218
},
219219

‎postgresql/documentation/html/_static/websupport.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@
566566
var context = $.extend({}, opts, comment);
567567
var div = $(renderTemplate(commentTemplate, context));
568568

569-
// If the user has voted on this comment, highblight the correct arrow.
569+
// If the user has voted on this comment, highlight the correct arrow.
570570
if (comment.vote) {
571571
var direction = (comment.vote == 1) ? 'u' : 'd';
572572
div.find('#' + direction + 'v' + comment.id).hide();

‎postgresql/documentation/html/admin.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
<head>
99
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1010

11-
<title>Administration &mdash; py-postgresql 1.0.4dev documentation</title>
11+
<title>Administration &mdash; py-postgresql 1.0.4 documentation</title>
1212

1313
<link rel="stylesheet" href="_static/default.css" type="text/css" />
1414
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1515

1616
<script type="text/javascript">
1717
var DOCUMENTATION_OPTIONS = {
1818
URL_ROOT: '',
19-
VERSION: '1.0.4dev',
19+
VERSION: '1.0.4',
2020
COLLAPSE_INDEX: false,
2121
FILE_SUFFIX: '.html',
2222
HAS_SOURCE: true
@@ -25,7 +25,7 @@
2525
<script type="text/javascript" src="_static/jquery.js"></script>
2626
<script type="text/javascript" src="_static/underscore.js"></script>
2727
<script type="text/javascript" src="_static/doctools.js"></script>
28-
<link rel="top" title="py-postgresql 1.0.4dev documentation" href="index.html" />
28+
<link rel="top" title="py-postgresql 1.0.4 documentation" href="index.html" />
2929
<link rel="next" title="Driver" href="driver.html" />
3030
<link rel="prev" title="py-postgresql" href="index.html" />
3131
</head>
@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="index.html" title="py-postgresql"
4747
accesskey="P">previous</a> |</li>
48-
<li><a href="index.html">py-postgresql 1.0.4dev documentation</a> &raquo;</li>
48+
<li><a href="index.html">py-postgresql 1.0.4 documentation</a> &raquo;</li>
4949
</ul>
5050
</div>
5151

@@ -150,13 +150,13 @@ <h3>Navigation</h3>
150150
<li class="right" >
151151
<a href="index.html" title="py-postgresql"
152152
>previous</a> |</li>
153-
<li><a href="index.html">py-postgresql 1.0.4dev documentation</a> &raquo;</li>
153+
<li><a href="index.html">py-postgresql 1.0.4 documentation</a> &raquo;</li>
154154
</ul>
155155
</div>
156156
<div class="footer">
157157
&copy; Copyright 2010, James William Pye &lt;[email protected]&gt;.
158-
Last updated on Oct 15, 2011.
159-
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1pre.
158+
Last updated on Apr 30, 2012.
159+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
160160
</div>
161161
</body>
162162
</html>

‎postgresql/documentation/html/alock.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
<head>
99
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1010

11-
<title>Advisory Locks &mdash; py-postgresql 1.0.4dev documentation</title>
11+
<title>Advisory Locks &mdash; py-postgresql 1.0.4 documentation</title>
1212

1313
<link rel="stylesheet" href="_static/default.css" type="text/css" />
1414
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1515

1616
<script type="text/javascript">
1717
var DOCUMENTATION_OPTIONS = {
1818
URL_ROOT: '',
19-
VERSION: '1.0.4dev',
19+
VERSION: '1.0.4',
2020
COLLAPSE_INDEX: false,
2121
FILE_SUFFIX: '.html',
2222
HAS_SOURCE: true
@@ -25,7 +25,7 @@
2525
<script type="text/javascript" src="_static/jquery.js"></script>
2626
<script type="text/javascript" src="_static/underscore.js"></script>
2727
<script type="text/javascript" src="_static/doctools.js"></script>
28-
<link rel="top" title="py-postgresql 1.0.4dev documentation" href="index.html" />
28+
<link rel="top" title="py-postgresql 1.0.4 documentation" href="index.html" />
2929
<link rel="next" title="Cluster Management" href="cluster.html" />
3030
<link rel="prev" title="Notification Management" href="notifyman.html" />
3131
</head>
@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="notifyman.html" title="Notification Management"
4747
accesskey="P">previous</a> |</li>
48-
<li><a href="index.html">py-postgresql 1.0.4dev documentation</a> &raquo;</li>
48+
<li><a href="index.html">py-postgresql 1.0.4 documentation</a> &raquo;</li>
4949
</ul>
5050
</div>
5151

@@ -216,13 +216,13 @@ <h3>Navigation</h3>
216216
<li class="right" >
217217
<a href="notifyman.html" title="Notification Management"
218218
>previous</a> |</li>
219-
<li><a href="index.html">py-postgresql 1.0.4dev documentation</a> &raquo;</li>
219+
<li><a href="index.html">py-postgresql 1.0.4 documentation</a> &raquo;</li>
220220
</ul>
221221
</div>
222222
<div class="footer">
223223
&copy; Copyright 2010, James William Pye &lt;[email protected]&gt;.
224-
Last updated on Oct 15, 2011.
225-
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1pre.
224+
Last updated on Apr 30, 2012.
225+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
226226
</div>
227227
</body>
228228
</html>

‎postgresql/documentation/html/bin.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
<head>
99
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1010

11-
<title>Commands &mdash; py-postgresql 1.0.4dev documentation</title>
11+
<title>Commands &mdash; py-postgresql 1.0.4 documentation</title>
1212

1313
<link rel="stylesheet" href="_static/default.css" type="text/css" />
1414
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1515

1616
<script type="text/javascript">
1717
var DOCUMENTATION_OPTIONS = {
1818
URL_ROOT: '',
19-
VERSION: '1.0.4dev',
19+
VERSION: '1.0.4',
2020
COLLAPSE_INDEX: false,
2121
FILE_SUFFIX: '.html',
2222
HAS_SOURCE: true
@@ -25,7 +25,7 @@
2525
<script type="text/javascript" src="_static/jquery.js"></script>
2626
<script type="text/javascript" src="_static/underscore.js"></script>
2727
<script type="text/javascript" src="_static/doctools.js"></script>
28-
<link rel="top" title="py-postgresql 1.0.4dev documentation" href="index.html" />
28+
<link rel="top" title="py-postgresql 1.0.4 documentation" href="index.html" />
2929
<link rel="next" title="Modules" href="modules.html" />
3030
<link rel="prev" title="Gotchas" href="gotchas.html" />
3131
</head>
@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="gotchas.html" title="Gotchas"
4747
accesskey="P">previous</a> |</li>
48-
<li><a href="index.html">py-postgresql 1.0.4dev documentation</a> &raquo;</li>
48+
<li><a href="index.html">py-postgresql 1.0.4 documentation</a> &raquo;</li>
4949
</ul>
5050
</div>
5151

@@ -161,26 +161,26 @@ <h3>Interactive Console Backslash Commands<a class="headerlink" href="#interacti
161161
\? Show this help message.
162162
\E Edit a file or a temporary script.
163163
\e Edit and Execute the file directly in the context.
164-
\i Execute a Python script within the interpreter's context.
164+
\i Execute a Python script within the interpreter&#x27;s context.
165165
\set Configure environment variables. \set without arguments to show all
166166
\x Execute the Python command within this process.</pre>
167167
</div>
168168
</div>
169169
<div class="section" id="pg-python-examples">
170170
<h3>pg_python Examples<a class="headerlink" href="#pg-python-examples" title="Permalink to this headline"></a></h3>
171171
<p>Module execution taking advantage of the new built-ins:</p>
172-
<div class="highlight-python"><pre>$ python3 -m postgresql.bin.pg_python -h localhost -W -m timeit "prepare('SELECT 1').first()"
172+
<div class="highlight-python"><pre>$ python3 -m postgresql.bin.pg_python -h localhost -W -m timeit &quot;prepare(&#x27;SELECT 1&#x27;).first()&quot;
173173
Password for pg_python[pq://jwp@localhost:5432]:
174174
1000 loops, best of 3: 1.35 msec per loop
175175

176-
$ python3 -m postgresql.bin.pg_python -h localhost -W -m timeit -s "ps=prepare('SELECT 1')" "ps.first()"
176+
$ python3 -m postgresql.bin.pg_python -h localhost -W -m timeit -s &quot;ps=prepare(&#x27;SELECT 1&#x27;)&quot; &quot;ps.first()&quot;
177177
Password for pg_python[pq://jwp@localhost:5432]:
178178
1000 loops, best of 3: 442 usec per loop</pre>
179179
</div>
180180
<p>Simple interactive usage:</p>
181181
<div class="highlight-python"><pre>$ python3 -m postgresql.bin.pg_python -h localhost -W
182182
Password for pg_python[pq://jwp@localhost:5432]:
183-
&gt;&gt;&gt; ps = prepare('select 1')
183+
&gt;&gt;&gt; ps = prepare(&#x27;select 1&#x27;)
184184
&gt;&gt;&gt; ps.first()
185185
1
186186
&gt;&gt;&gt; c = ps()
@@ -235,32 +235,32 @@ <h3>pg_dotconf Usage<a class="headerlink" href="#pg-dotconf-usage" title="Permal
235235
<div class="section" id="examples">
236236
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h3>
237237
<p>Modifying a simple configuration file:</p>
238-
<div class="highlight-python"><pre>$ echo "setting = value" &gt;pg.conf
238+
<div class="highlight-python"><pre>$ echo &quot;setting = value&quot; &gt;pg.conf
239239

240-
# change 'setting'
240+
# change &#x27;setting&#x27;
241241
$ python3 -m postgresql.bin.pg_dotconf pg.conf setting=newvalue
242242

243243
$ cat pg.conf
244-
setting = 'newvalue'
244+
setting = &#x27;newvalue&#x27;
245245

246246
# new settings are appended to the file
247247
$ python3 -m postgresql.bin.pg_dotconf pg.conf another_setting=value
248248
$ cat pg.conf
249-
setting = 'newvalue'
250-
another_setting = 'value'
249+
setting = &#x27;newvalue&#x27;
250+
another_setting = &#x27;value&#x27;
251251

252252
# comment a setting
253253
$ python3 -m postgresql.bin.pg_dotconf pg.conf another_setting
254254

255255
$ cat pg.conf
256-
setting = 'newvalue'
257-
#another_setting = 'value'</pre>
256+
setting = &#x27;newvalue&#x27;
257+
#another_setting = &#x27;value&#x27;</pre>
258258
</div>
259259
<p>When a setting is given on the command line, it must been seen as one argument
260260
to the command, so it&#8217;s <em>very</em> important to avoid invocations like:</p>
261261
<div class="highlight-python"><pre>$ python3 -m postgresql.bin.pg_dotconf pg.conf setting = value
262-
ERROR: invalid setting, '=' after 'setting'
263-
HINT: Settings must take the form 'setting=value' or 'setting_name_to_comment'. Settings must also be received as a single argument.</pre>
262+
ERROR: invalid setting, &#x27;=&#x27; after &#x27;setting&#x27;
263+
HINT: Settings must take the form &#x27;setting=value&#x27; or &#x27;setting_name_to_comment&#x27;. Settings must also be received as a single argument.</pre>
264264
</div>
265265
</div>
266266
</div>
@@ -333,13 +333,13 @@ <h3>Navigation</h3>
333333
<li class="right" >
334334
<a href="gotchas.html" title="Gotchas"
335335
>previous</a> |</li>
336-
<li><a href="index.html">py-postgresql 1.0.4dev documentation</a> &raquo;</li>
336+
<li><a href="index.html">py-postgresql 1.0.4 documentation</a> &raquo;</li>
337337
</ul>
338338
</div>
339339
<div class="footer">
340340
&copy; Copyright 2010, James William Pye &lt;[email protected]&gt;.
341-
Last updated on Oct 15, 2011.
342-
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1pre.
341+
Last updated on Apr 30, 2012.
342+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
343343
</div>
344344
</body>
345345
</html>

‎postgresql/documentation/html/changes-v1.0.html

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
<head>
99
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1010

11-
<title>Changes in v1.0 &mdash; py-postgresql 1.0.4dev documentation</title>
11+
<title>Changes in v1.0 &mdash; py-postgresql 1.0.4 documentation</title>
1212

1313
<link rel="stylesheet" href="_static/default.css" type="text/css" />
1414
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1515

1616
<script type="text/javascript">
1717
var DOCUMENTATION_OPTIONS = {
1818
URL_ROOT: '',
19-
VERSION: '1.0.4dev',
19+
VERSION: '1.0.4',
2020
COLLAPSE_INDEX: false,
2121
FILE_SUFFIX: '.html',
2222
HAS_SOURCE: true
@@ -25,7 +25,7 @@
2525
<script type="text/javascript" src="_static/jquery.js"></script>
2626
<script type="text/javascript" src="_static/underscore.js"></script>
2727
<script type="text/javascript" src="_static/doctools.js"></script>
28-
<link rel="top" title="py-postgresql 1.0.4dev documentation" href="index.html" />
28+
<link rel="top" title="py-postgresql 1.0.4 documentation" href="index.html" />
2929
<link rel="prev" title="Modules" href="modules.html" />
3030
</head>
3131
<body>
@@ -41,7 +41,7 @@ <h3>Navigation</h3>
4141
<li class="right" >
4242
<a href="modules.html" title="Modules"
4343
accesskey="P">previous</a> |</li>
44-
<li><a href="index.html">py-postgresql 1.0.4dev documentation</a> &raquo;</li>
44+
<li><a href="index.html">py-postgresql 1.0.4 documentation</a> &raquo;</li>
4545
</ul>
4646
</div>
4747

@@ -56,6 +56,10 @@ <h1>Changes in v1.0<a class="headerlink" href="#changes-in-v1-0" title="Permalin
5656
<h2>1.0.4 in development<a class="headerlink" href="#in-development" title="Permalink to this headline"></a></h2>
5757
<blockquote>
5858
<div><ul class="simple">
59+
<li>Fix usage of weakrefs for statement/cursor GC. (Elvis Pranskevichus)
60+
(Fixes mysterious DuplicateCursorError exceptions)</li>
61+
<li>Add support for binary inet/cidr/macaddr types for use with arrays and composites. (Matthew Grant &amp; Barry Grussling)</li>
62+
<li>Add support for (un)pickling postgresql.types.Array objects. (Elvis Pranskevichus)</li>
5963
<li>Alter how changes are represented in documentation to simplify merging.</li>
6064
</ul>
6165
</div></blockquote>
@@ -201,13 +205,13 @@ <h3>Navigation</h3>
201205
<li class="right" >
202206
<a href="modules.html" title="Modules"
203207
>previous</a> |</li>
204-
<li><a href="index.html">py-postgresql 1.0.4dev documentation</a> &raquo;</li>
208+
<li><a href="index.html">py-postgresql 1.0.4 documentation</a> &raquo;</li>
205209
</ul>
206210
</div>
207211
<div class="footer">
208212
&copy; Copyright 2010, James William Pye &lt;[email protected]&gt;.
209-
Last updated on Oct 15, 2011.
210-
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1pre.
213+
Last updated on Apr 30, 2012.
214+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
211215
</div>
212216
</body>
213217
</html>

0 commit comments

Comments
 (0)