Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 4efcb54

Browse files
committed
Update devel docs: we use Sphinx instead of pudge
1 parent d6d6121 commit 4efcb54

File tree

76 files changed

+189
-191
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+189
-191
lines changed

‎devel/DeveloperGuide.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -351,9 +351,8 @@ <h2>Testing<a class="headerlink" href="#testing" title="Permalink to this headli
351351
<div class="section" id="documentation">
352352
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h2>
353353
<p>Please write documentation. Documentation should live in the docs/
354-
directory. Pudge converts documentation from Restructured Text to
355-
HTML. It presently requires kid 0.9.6, which must be obtained
356-
separately (for instance, from <a class="reference external" href="https://pypi.python.org/pypi/kid/0.9.6">https://pypi.python.org/pypi/kid/0.9.6</a>).</p>
354+
directory in reStructuredText format. We use Sphinx to convert docs to
355+
HTML.</p>
357356
<a class="reference external image-reference" href="https://sourceforge.net/projects/sqlobject"><img alt="Get SQLObject at SourceForge.net. Fast, secure and Free Open Source software downloads" class="noborder align-center" src="https://sourceforge.net/sflogo.php?group_id=74338&amp;type=10" style="width: 80px; height: 15px;" /></a>
358357
</div>
359358
</div>

‎devel/_sources/DeveloperGuide.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,9 +285,8 @@ Documentation
285285
=============
286286

287287
Please write documentation. Documentation should live in the docs/
288-
directory. Pudge converts documentation from Restructured Text to
289-
HTML. It presently requires kid 0.9.6, which must be obtained
290-
separately (for instance, from https://pypi.python.org/pypi/kid/0.9.6).
288+
directory in reStructuredText format. We use Sphinx to convert docs to
289+
HTML.
291290

292291
.. image:: https://sourceforge.net/sflogo.php?group_id=74338&type=10
293292
:target: https://sourceforge.net/projects/sqlobject

‎devel/api/sqlobject.include.tests.test_hashcol.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ <h3>Quick search</h3>
120120

121121
<dl class="attribute">
122122
<dt id="sqlobject.include.tests.test_hashcol.HashTest.sqlmeta.columnDefinitions">
123-
<code class="descname">columnDefinitions</code><em class="property"> = {'count': &lt;IntCol b5144c0cL count&gt;, 'col2': &lt;HashCol b506478cL col2&gt;, 'col1': &lt;HashCol b5064dccL col1&gt;}</em><a class="headerlink" href="#sqlobject.include.tests.test_hashcol.HashTest.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
123+
<code class="descname">columnDefinitions</code><em class="property"> = {'count': &lt;IntCol b52e042cL count&gt;, 'col2': &lt;HashCol b5325aecL col2&gt;, 'col1': &lt;HashCol b5325c2cL col1&gt;}</em><a class="headerlink" href="#sqlobject.include.tests.test_hashcol.HashTest.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
124124
<dd></dd></dl>
125125

126126
<dl class="attribute">

‎devel/api/sqlobject.inheritance.tests.test_aggregates.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h3>Quick search</h3>
110110

111111
<dl class="attribute">
112112
<dt id="sqlobject.inheritance.tests.test_aggregates.SOTestAggregate1.sqlmeta.columnDefinitions">
113-
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b54e8aecL childName&gt;, 'value1': &lt;IntCol b4e563acL value1&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_aggregates.SOTestAggregate1.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
113+
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b521cbccL childName&gt;, 'value1': &lt;IntCol b572a44cL value1&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_aggregates.SOTestAggregate1.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
114114
<dd></dd></dl>
115115

116116
<dl class="attribute">
@@ -203,7 +203,7 @@ <h3>Quick search</h3>
203203

204204
<dl class="attribute">
205205
<dt id="sqlobject.inheritance.tests.test_aggregates.SOTestAggregate2.sqlmeta.columnDefinitions">
206-
<code class="descname">columnDefinitions</code><em class="property"> = {'value2': &lt;IntCol b4fac4ccL value2&gt;, 'childName': &lt;StringCol b50640acL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_aggregates.SOTestAggregate2.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
206+
<code class="descname">columnDefinitions</code><em class="property"> = {'value2': &lt;IntCol b57208ecL value2&gt;, 'childName': &lt;StringCol b532532cL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_aggregates.SOTestAggregate2.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
207207
<dd></dd></dl>
208208

209209
<dl class="attribute">

‎devel/api/sqlobject.inheritance.tests.test_asdict.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ <h3>Quick search</h3>
120120

121121
<dl class="attribute">
122122
<dt id="sqlobject.inheritance.tests.test_asdict.EmployeeAD.sqlmeta.columnDefinitions">
123-
<code class="descname">columnDefinitions</code><em class="property"> = {'position': &lt;StringCol b5026e2cL position&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_asdict.EmployeeAD.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
123+
<code class="descname">columnDefinitions</code><em class="property"> = {'position': &lt;StringCol b55cc8ccL position&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_asdict.EmployeeAD.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
124124
<dd></dd></dl>
125125

126126
<dl class="attribute">
@@ -224,7 +224,7 @@ <h3>Quick search</h3>
224224

225225
<dl class="attribute">
226226
<dt id="sqlobject.inheritance.tests.test_asdict.InheritablePersonAD.sqlmeta.columnDefinitions">
227-
<code class="descname">columnDefinitions</code><em class="property"> = {'lastName': &lt;StringCol b4e4da6cL lastName&gt;, 'childName': &lt;StringCol b4df0facL childName&gt;, 'firstName': &lt;StringCol b4e4d68cL firstName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_asdict.InheritablePersonAD.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
227+
<code class="descname">columnDefinitions</code><em class="property"> = {'lastName': &lt;StringCol b53cea6cL lastName&gt;, 'childName': &lt;StringCol b5727fccL childName&gt;, 'firstName': &lt;StringCol b53ced6cL firstName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_asdict.InheritablePersonAD.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
228228
<dd></dd></dl>
229229

230230
<dl class="attribute">
@@ -327,7 +327,7 @@ <h3>Quick search</h3>
327327

328328
<dl class="attribute">
329329
<dt id="sqlobject.inheritance.tests.test_asdict.ManagerAD.sqlmeta.columnDefinitions">
330-
<code class="descname">columnDefinitions</code><em class="property"> = {'department': &lt;StringCol b632f88cL department&gt;, 'childName': &lt;StringCol b4e4d70cL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_asdict.ManagerAD.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
330+
<code class="descname">columnDefinitions</code><em class="property"> = {'department': &lt;StringCol b579558cL department&gt;, 'childName': &lt;StringCol b55ae24cL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_asdict.ManagerAD.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
331331
<dd></dd></dl>
332332

333333
<dl class="attribute">

‎devel/api/sqlobject.inheritance.tests.test_deep_inheritance.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h3>Quick search</h3>
135135

136136
<dl class="attribute">
137137
<dt id="sqlobject.inheritance.tests.test_deep_inheritance.DIEmployee.sqlmeta.columnDefinitions">
138-
<code class="descname">columnDefinitions</code><em class="property"> = {'position': &lt;StringCol b4e3fcacL position&gt;, 'childName': &lt;StringCol b4e3f7acL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_deep_inheritance.DIEmployee.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
138+
<code class="descname">columnDefinitions</code><em class="property"> = {'position': &lt;StringCol b5599f8cL position&gt;, 'childName': &lt;StringCol b57a036cL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_deep_inheritance.DIEmployee.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
139139
<dd></dd></dl>
140140

141141
<dl class="attribute">
@@ -229,7 +229,7 @@ <h3>Quick search</h3>
229229

230230
<dl class="attribute">
231231
<dt id="sqlobject.inheritance.tests.test_deep_inheritance.DIManager.sqlmeta.columnDefinitions">
232-
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b4e6caccL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_deep_inheritance.DIManager.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
232+
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b5720e6cL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_deep_inheritance.DIManager.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
233233
<dd></dd></dl>
234234

235235
<dl class="attribute">
@@ -348,7 +348,7 @@ <h3>Quick search</h3>
348348

349349
<dl class="attribute">
350350
<dt id="sqlobject.inheritance.tests.test_deep_inheritance.DIPerson.sqlmeta.columnDefinitions">
351-
<code class="descname">columnDefinitions</code><em class="property"> = {'lastName': &lt;StringCol b4e8e1acL lastName&gt;, 'childName': &lt;StringCol b4e5832cL childName&gt;, 'firstName': &lt;StringCol b4e8e10cL firstName&gt;, 'managerID': &lt;ForeignKey b4e8e08cL manager&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_deep_inheritance.DIPerson.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
351+
<code class="descname">columnDefinitions</code><em class="property"> = {'lastName': &lt;StringCol b64eb96cL lastName&gt;, 'childName': &lt;StringCol b56c4b6cL childName&gt;, 'firstName': &lt;StringCol b623c8ecL firstName&gt;, 'managerID': &lt;ForeignKey b623cbacL manager&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_deep_inheritance.DIPerson.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
352352
<dd></dd></dl>
353353

354354
<dl class="attribute">

‎devel/api/sqlobject.inheritance.tests.test_destroy_cascade.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ <h3>Quick search</h3>
115115

116116
<dl class="attribute">
117117
<dt id="sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade1.sqlmeta.columnDefinitions">
118-
<code class="descname">columnDefinitions</code><em class="property"> = {'dummy': &lt;IntCol b535bc6cL dummy&gt;, 'childName': &lt;StringCol b4d86a0cL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade1.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
118+
<code class="descname">columnDefinitions</code><em class="property"> = {'dummy': &lt;IntCol b50a636cL dummy&gt;, 'childName': &lt;StringCol b50aa62cL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade1.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
119119
<dd></dd></dl>
120120

121121
<dl class="attribute">
@@ -218,7 +218,7 @@ <h3>Quick search</h3>
218218

219219
<dl class="attribute">
220220
<dt id="sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade2.sqlmeta.columnDefinitions">
221-
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b6193facL childName&gt;, 'cID': &lt;ForeignKey b50a210cL c&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade2.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
221+
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b4ffd64cL childName&gt;, 'cID': &lt;ForeignKey b4ffd5ecL c&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade2.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
222222
<dd></dd></dl>
223223

224224
<dl class="attribute">
@@ -302,7 +302,7 @@ <h3>Quick search</h3>
302302

303303
<dl class="attribute">
304304
<dt id="sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade3.sqlmeta.columnDefinitions">
305-
<code class="descname">columnDefinitions</code><em class="property"> = {'dummy': &lt;IntCol b5010dccL dummy&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade3.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
305+
<code class="descname">columnDefinitions</code><em class="property"> = {'dummy': &lt;IntCol b5643f2cL dummy&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_destroy_cascade.SOTestCascade3.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
306306
<dd></dd></dl>
307307

308308
<dl class="attribute">

‎devel/api/sqlobject.inheritance.tests.test_foreignKey.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ <h3>Quick search</h3>
130130

131131
<dl class="attribute">
132132
<dt id="sqlobject.inheritance.tests.test_foreignKey.EmployeeWithNotes.sqlmeta.columnDefinitions">
133-
<code class="descname">columnDefinitions</code><em class="property"> = {'paperID': &lt;ForeignKey b6b8d44cL paper&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.EmployeeWithNotes.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
133+
<code class="descname">columnDefinitions</code><em class="property"> = {'paperID': &lt;ForeignKey b57679acL paper&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.EmployeeWithNotes.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
134134
<dd></dd></dl>
135135

136136
<dl class="attribute">
@@ -209,7 +209,7 @@ <h3>Quick search</h3>
209209

210210
<dl class="attribute">
211211
<dt id="sqlobject.inheritance.tests.test_foreignKey.Note.sqlmeta.columnDefinitions">
212-
<code class="descname">columnDefinitions</code><em class="property"> = {'text': &lt;StringCol b4fe69acL text&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.Note.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
212+
<code class="descname">columnDefinitions</code><em class="property"> = {'text': &lt;StringCol b4f8144cL text&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.Note.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
213213
<dd></dd></dl>
214214

215215
<dl class="attribute">
@@ -302,7 +302,7 @@ <h3>Quick search</h3>
302302

303303
<dl class="attribute">
304304
<dt id="sqlobject.inheritance.tests.test_foreignKey.Paper.sqlmeta.columnDefinitions">
305-
<code class="descname">columnDefinitions</code><em class="property"> = {'content': &lt;StringCol b6521facL content&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.Paper.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
305+
<code class="descname">columnDefinitions</code><em class="property"> = {'content': &lt;StringCol b576740cL content&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.Paper.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
306306
<dd></dd></dl>
307307

308308
<dl class="attribute">
@@ -415,7 +415,7 @@ <h3>Quick search</h3>
415415

416416
<dl class="attribute">
417417
<dt id="sqlobject.inheritance.tests.test_foreignKey.PersonWithNotes.sqlmeta.columnDefinitions">
418-
<code class="descname">columnDefinitions</code><em class="property"> = {'lastName': &lt;StringCol b517a3ccL lastName&gt;, 'childName': &lt;StringCol b501084cL childName&gt;, 'noteID': &lt;ForeignKey b64529acL note&gt;, 'firstName': &lt;StringCol b517a1ccL firstName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.PersonWithNotes.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
418+
<code class="descname">columnDefinitions</code><em class="property"> = {'lastName': &lt;StringCol b4ffd4ccL lastName&gt;, 'childName': &lt;StringCol b564352cL childName&gt;, 'noteID': &lt;ForeignKey b4ffd98cL note&gt;, 'firstName': &lt;StringCol b4f8104cL firstName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.PersonWithNotes.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
419419
<dd></dd></dl>
420420

421421
<dl class="attribute">
@@ -503,7 +503,7 @@ <h3>Quick search</h3>
503503

504504
<dl class="attribute">
505505
<dt id="sqlobject.inheritance.tests.test_foreignKey.SOTestInheritableBase.sqlmeta.columnDefinitions">
506-
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b65629acL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.SOTestInheritableBase.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
506+
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b4febeecL childName&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.SOTestInheritableBase.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
507507
<dd></dd></dl>
508508

509509
<dl class="attribute">
@@ -601,7 +601,7 @@ <h3>Quick search</h3>
601601

602602
<dl class="attribute">
603603
<dt id="sqlobject.inheritance.tests.test_foreignKey.SOTestInheritableForeignKey.sqlmeta.columnDefinitions">
604-
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b63f7f2cL childName&gt;, 'baseID': &lt;ForeignKey b50313acL base&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.SOTestInheritableForeignKey.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
604+
<code class="descname">columnDefinitions</code><em class="property"> = {'childName': &lt;StringCol b5014cccL childName&gt;, 'baseID': &lt;ForeignKey b576792cL base&gt;}</em><a class="headerlink" href="#sqlobject.inheritance.tests.test_foreignKey.SOTestInheritableForeignKey.sqlmeta.columnDefinitions" title="Permalink to this definition"></a></dt>
605605
<dd></dd></dl>
606606

607607
<dl class="attribute">

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /