Skip to content

Commit 86d9eab

Browse files
committed
Update devel docs (document [ci skip])
1 parent 48eb950 commit 86d9eab

8 files changed

+889
-783
lines changed

devel/DeveloperGuide.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,9 @@ <h1>Testing</h1>
261261
exercised, even if the tests are absolutely complete.</p>
262262
<p>We now use Travis CI to run tests. See the status:</p>
263263
<a href="https://travis-ci.org/sqlobject/sqlobject" class="reference external image-reference"><img src="https://travis-ci.org/sqlobject/sqlobject.svg?branch=master" alt="https://travis-ci.org/sqlobject/sqlobject.svg?branch=master"></a>
264+
<p>To avoid triggering unnecessary test run at Travis add text <a href="https://docs.travis-ci.com/user/customizing-the-build/#Skipping-a-build" class="reference external">[ci skip]</a>
265+
anywhere in your commit messages for commits that don't change code
266+
(documentation updates and such).</p>
264267
</div>
265268
<div class="section" id="documentation">
266269
<h1>Documentation</h1>

devel/module-sqlobject-index.html

Lines changed: 682 additions & 605 deletions
Large diffs are not rendered by default.

devel/module-sqlobject.col-index.html

Lines changed: 24 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -644,6 +644,13 @@ <h1>Index of the <tt>col</tt> module</h1>
644644
</a>
645645
<a href="sqlobject/col.py.html?f=491&amp;l=503#491">...</a>
646646
<small></small>
647+
</li><li class="routine">
648+
<span class="prefix">f</span>
649+
<a href="class-sqlobject.col.SOStringLikeCol.html#maxdbCreateSQL">
650+
<tt>maxdbCreateSQL</tt>
651+
</a>
652+
<a href="sqlobject/col.py.html?f=392&amp;l=394#392">...</a>
653+
<small></small>
647654
</li><li class="routine">
648655
<span class="prefix">f</span>
649656
<a href="class-sqlobject.col.SOStringLikeCol.html#sqliteCreateSQL">
@@ -1426,13 +1433,6 @@ <h1>Index of the <tt>col</tt> module</h1>
14261433
</a>
14271434
<a href="sqlobject/col.py.html?f=363&amp;l=366#363">...</a>
14281435
<small></small>
1429-
</li><li class="routine">
1430-
<span class="prefix">f</span>
1431-
<a href="class-sqlobject.col.PickleCol.baseClass.html#sybaseCreateSQL">
1432-
<tt>sybaseCreateSQL</tt>
1433-
</a>
1434-
<a href="sqlobject/col.py.html?f=373&amp;l=375#373">...</a>
1435-
<small></small>
14361436
</li><li class="routine">
14371437
<span class="prefix">f</span>
14381438
<a href="class-sqlobject.col.PickleCol.baseClass.html#createSQL">
@@ -1595,6 +1595,13 @@ <h1>Index of the <tt>col</tt> module</h1>
15951595
</a>
15961596
<a href="sqlobject/col.py.html?f=363&amp;l=366#363">...</a>
15971597
<small></small>
1598+
</li><li class="routine">
1599+
<span class="prefix">f</span>
1600+
<a href="class-sqlobject.col.DecimalCol.baseClass.html#autoConstraints">
1601+
<tt>autoConstraints</tt>
1602+
</a>
1603+
<a href="sqlobject/col.py.html?f=284&amp;l=286#284">...</a>
1604+
<small></small>
15981605
</li><li class="routine">
15991606
<span class="prefix">f</span>
16001607
<a href="class-sqlobject.col.DecimalCol.baseClass.html#sybaseCreateSQL">
@@ -1699,6 +1706,13 @@ <h1>Index of the <tt>col</tt> module</h1>
16991706
<ul>
17001707
<li class="routine">
17011708
<span class="prefix">f</span>
1709+
<a href="class-sqlobject.col.SmallIntCol.baseClass.html#__set__">
1710+
<tt>__set__</tt>
1711+
</a>
1712+
<a href="sqlobject/col.py.html?f=413&amp;l=419#413">...</a>
1713+
<small></small>
1714+
</li><li class="routine">
1715+
<span class="prefix">f</span>
17021716
<a href="class-sqlobject.col.SmallIntCol.baseClass.html#mssqlCreateSQL">
17031717
<tt>mssqlCreateSQL</tt>
17041718
</a>
@@ -1718,13 +1732,6 @@ <h1>Index of the <tt>col</tt> module</h1>
17181732
</a>
17191733
<a href="sqlobject/col.py.html?f=750&amp;l=755#750">...</a>
17201734
<small></small>
1721-
</li><li class="routine">
1722-
<span class="prefix">f</span>
1723-
<a href="class-sqlobject.col.SmallIntCol.baseClass.html#sqliteCreateSQL">
1724-
<tt>sqliteCreateSQL</tt>
1725-
</a>
1726-
<a href="sqlobject/col.py.html?f=370&amp;l=372#370">...</a>
1727-
<small></small>
17281735
</li><li class="routine">
17291736
<span class="prefix">f</span>
17301737
<a href="class-sqlobject.col.SmallIntCol.baseClass.html#mysqlCreateSQL">
@@ -1870,13 +1877,6 @@ <h1>Index of the <tt>col</tt> module</h1>
18701877
</a>
18711878
<a href="sqlobject/col.py.html?f=1017&amp;l=1020#1017">...</a>
18721879
<small></small>
1873-
</li><li class="routine">
1874-
<span class="prefix">f</span>
1875-
<a href="class-sqlobject.col.SOForeignKey.html#mysqlCreateReferenceConstraint">
1876-
<tt>mysqlCreateReferenceConstraint</tt>
1877-
</a>
1878-
<a href="sqlobject/col.py.html?f=1047&amp;l=1074#1047">...</a>
1879-
<small></small>
18801880
</li><li class="routine">
18811881
<span class="prefix">f</span>
18821882
<a href="class-sqlobject.col.SOForeignKey.html#createValidators">
@@ -1919,10 +1919,10 @@ <h1>Index of the <tt>col</tt> module</h1>
19191919
<small></small>
19201920
</li><li class="routine">
19211921
<span class="prefix">f</span>
1922-
<a href="class-sqlobject.col.SOEnumCol.html#__init__">
1923-
<tt>__init__</tt>
1922+
<a href="class-sqlobject.col.SOEnumCol.html#mysqlCreateSQL">
1923+
<tt>mysqlCreateSQL</tt>
19241924
</a>
1925-
<a href="sqlobject/col.py.html?f=1155&amp;l=1160#1155">...</a>
1925+
<a href="sqlobject/col.py.html?f=363&amp;l=366#363">...</a>
19261926
<small></small>
19271927
</li><li class="routine">
19281928
<span class="prefix">f</span>
@@ -1950,25 +1950,11 @@ <h1>Index of the <tt>col</tt> module</h1>
19501950
<ul>
19511951
<li class="routine">
19521952
<span class="prefix">f</span>
1953-
<a href="class-sqlobject.col.SOUuidCol.html#getDbEncoding">
1954-
<tt>getDbEncoding</tt>
1955-
</a>
1956-
<a href="sqlobject/col.py.html?f=423&amp;l=438#423">...</a>
1957-
<small></small>
1958-
</li><li class="routine">
1959-
<span class="prefix">f</span>
19601953
<a href="class-sqlobject.col.SOUuidCol.html#maxdbCreateSQL">
19611954
<tt>maxdbCreateSQL</tt>
19621955
</a>
19631956
<a href="sqlobject/col.py.html?f=392&amp;l=394#392">...</a>
19641957
<small></small>
1965-
</li><li class="routine">
1966-
<span class="prefix">f</span>
1967-
<a href="class-sqlobject.col.SOUuidCol.html#sybaseCreateSQL">
1968-
<tt>sybaseCreateSQL</tt>
1969-
</a>
1970-
<a href="sqlobject/col.py.html?f=373&amp;l=375#373">...</a>
1971-
<small></small>
19721958
</li>
19731959
</ul>
19741960
</li><li class="class">

devel/module-sqlobject.manager-index.html

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -348,13 +348,6 @@ <h1>Index of the <tt>manager</tt> module</h1>
348348
<ul>
349349
<li class="routine">
350350
<span class="prefix">f</span>
351-
<a href="class-sqlobject.manager.command.CommandRunner.html#register">
352-
<tt>register</tt>
353-
</a>
354-
<a href="sqlobject/manager/command.py.html?f=115&amp;l=120#115">...</a>
355-
<small></small>
356-
</li><li class="routine">
357-
<span class="prefix">f</span>
358351
<a href="class-sqlobject.manager.command.CommandRunner.html#run">
359352
<tt>run</tt>
360353
</a>
@@ -474,20 +467,6 @@ <h1>Index of the <tt>manager</tt> module</h1>
474467
- <span class="rst">Shortens a filename to make it relative to the current
475468
directory (if it can). For display purposes.</span>
476469
</small>
477-
</li><li class="routine">
478-
<span class="prefix">f</span>
479-
<a href="class-sqlobject.manager.command.CommandExecute.html#config_from_egg">
480-
<tt>config_from_egg</tt>
481-
</a>
482-
<a href="sqlobject/manager/command.py.html?f=523&amp;l=542#523">...</a>
483-
<small></small>
484-
</li><li class="routine">
485-
<span class="prefix">f</span>
486-
<a href="class-sqlobject.manager.command.CommandExecute.html#classes_from_package">
487-
<tt>classes_from_package</tt>
488-
</a>
489-
<a href="sqlobject/manager/command.py.html?f=468&amp;l=501#468">...</a>
490-
<small></small>
491470
</li><li class="routine">
492471
<span class="prefix">f</span>
493472
<a href="class-sqlobject.manager.command.CommandExecute.html#ask">
@@ -705,13 +684,6 @@ <h1>Index of the <tt>manager</tt> module</h1>
705684
</a>
706685
<a href="sqlobject/manager/command.py.html?f=325&amp;l=383#325">...</a>
707686
<small></small>
708-
</li><li class="routine">
709-
<span class="prefix">f</span>
710-
<a href="class-sqlobject.manager.command.CommandHelp.html#load_options_from_egg">
711-
<tt>load_options_from_egg</tt>
712-
</a>
713-
<a href="sqlobject/manager/command.py.html?f=515&amp;l=522#515">...</a>
714-
<small></small>
715687
</li>
716688
</ul>
717689
</li><li class="class">
@@ -732,13 +704,6 @@ <h1>Index of the <tt>manager</tt> module</h1>
732704
- <span class="rst">Shortens a filename to make it relative to the current
733705
directory (if it can). For display purposes.</span>
734706
</small>
735-
</li><li class="routine">
736-
<span class="prefix">f</span>
737-
<a href="class-sqlobject.manager.command.Command.html#classes_from_module">
738-
<tt>classes_from_module</tt>
739-
</a>
740-
<a href="sqlobject/manager/command.py.html?f=384&amp;l=399#384">...</a>
741-
<small></small>
742707
</li><li class="routine">
743708
<span class="prefix">f</span>
744709
<a href="class-sqlobject.manager.command.Command.html#connection">

devel/module-sqlobject.manager.command-index.html

Lines changed: 32 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -661,13 +661,6 @@ <h1>Index of the <tt>command</tt> module</h1>
661661
</a>
662662
<a href="sqlobject/manager/command.py.html?f=468&amp;l=501#468">...</a>
663663
<small></small>
664-
</li><li class="routine">
665-
<span class="prefix">f</span>
666-
<a href="class-sqlobject.manager.command.CommandHelp.html#classes">
667-
<tt>classes</tt>
668-
</a>
669-
<a href="sqlobject/manager/command.py.html?f=325&amp;l=383#325">...</a>
670-
<small></small>
671664
</li>
672665
</ul>
673666
</li><li class="class">
@@ -695,13 +688,6 @@ <h1>Index of the <tt>command</tt> module</h1>
695688
</a>
696689
<a href="sqlobject/manager/command.py.html?f=468&amp;l=501#468">...</a>
697690
<small></small>
698-
</li><li class="routine">
699-
<span class="prefix">f</span>
700-
<a href="class-sqlobject.manager.command.Command.html#classes">
701-
<tt>classes</tt>
702-
</a>
703-
<a href="sqlobject/manager/command.py.html?f=325&amp;l=383#325">...</a>
704-
<small></small>
705691
</li>
706692
</ul>
707693
</li><li class="class">
@@ -751,13 +737,6 @@ <h1>Index of the <tt>command</tt> module</h1>
751737
</a>
752738
<a href="sqlobject/manager/command.py.html?f=468&amp;l=501#468">...</a>
753739
<small></small>
754-
</li><li class="routine">
755-
<span class="prefix">f</span>
756-
<a href="class-sqlobject.manager.command.CommandDrop.html#classes">
757-
<tt>classes</tt>
758-
</a>
759-
<a href="sqlobject/manager/command.py.html?f=325&amp;l=383#325">...</a>
760-
<small></small>
761740
</li>
762741
</ul>
763742
</li><li class="class">
@@ -799,6 +778,17 @@ <h1>Index of the <tt>command</tt> module</h1>
799778
</li>
800779
<li class="routine">
801780
<span class="prefix">f</span>
781+
<a href="class-sqlobject.manager.command.CommandStatus.html#open_editor">
782+
<tt>open_editor</tt>
783+
</a>
784+
<a href="sqlobject/manager/command.py.html?f=574&amp;l=595#574">...</a>
785+
<small>
786+
- <span class="rst">Open an editor with the given text. Return the new text,
787+
or None if no edits were made. If given, everything after
788+
<cite>breaker</cite> will be ignored.</span>
789+
</small>
790+
</li><li class="routine">
791+
<span class="prefix">f</span>
802792
<a href="class-sqlobject.manager.command.CommandStatus.html#shorten_filename">
803793
<tt>shorten_filename</tt>
804794
</a>
@@ -807,6 +797,13 @@ <h1>Index of the <tt>command</tt> module</h1>
807797
- <span class="rst">Shortens a filename to make it relative to the current
808798
directory (if it can). For display purposes.</span>
809799
</small>
800+
</li><li class="routine">
801+
<span class="prefix">f</span>
802+
<a href="class-sqlobject.manager.command.CommandStatus.html#config_from_egg">
803+
<tt>config_from_egg</tt>
804+
</a>
805+
<a href="sqlobject/manager/command.py.html?f=523&amp;l=542#523">...</a>
806+
<small></small>
810807
</li><li class="routine">
811808
<span class="prefix">f</span>
812809
<a href="class-sqlobject.manager.command.CommandStatus.html#classes">
@@ -900,6 +897,13 @@ <h1>Index of the <tt>command</tt> module</h1>
900897
top level (independant) classes to the deepest level.
901898
The dependency tree is defined by the foreign key relations.</span>
902899
</small>
900+
</li><li class="routine">
901+
<span class="prefix">f</span>
902+
<a href="class-sqlobject.manager.command.CommandRecord.html#classes_from_package">
903+
<tt>classes_from_package</tt>
904+
</a>
905+
<a href="sqlobject/manager/command.py.html?f=468&amp;l=501#468">...</a>
906+
<small></small>
903907
</li><li class="routine">
904908
<span class="prefix">f</span>
905909
<a href="class-sqlobject.manager.command.CommandRecord.html#classes">
@@ -993,6 +997,13 @@ <h1>Index of the <tt>command</tt> module</h1>
993997
</a>
994998
<a href="sqlobject/manager/command.py.html?f=1102&amp;l=1116#1102">...</a>
995999
<small></small>
1000+
</li><li class="routine">
1001+
<span class="prefix">f</span>
1002+
<a href="class-sqlobject.manager.command.CommandUpgrade.html#load_options_from_egg">
1003+
<tt>load_options_from_egg</tt>
1004+
</a>
1005+
<a href="sqlobject/manager/command.py.html?f=515&amp;l=522#515">...</a>
1006+
<small></small>
9961007
</li>
9971008
</ul>
9981009
</li>

devel/module-sqlobject.maxdb-index.html

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,14 @@ <h1>Index of the <tt>maxdb</tt> module</h1>
290290
<a href="sqlobject/maxdb/maxdbconnection.py.html?f=45&amp;l=51#45">...</a>
291291
<small></small>
292292
<ul>
293+
<li class="routine">
294+
<span class="prefix">f</span>
295+
<a href="class-sqlobject.maxdb.maxdbconnection.StyleMismatchError.html#__init__">
296+
<tt>__init__</tt>
297+
</a>
298+
<a href="sqlobject/maxdb/maxdbconnection.py.html?f=46&amp;l=51#46">...</a>
299+
<small></small>
300+
</li>
293301
</ul>
294302
</li><li class="class">
295303
<span class="prefix">C</span>
@@ -316,6 +324,14 @@ <h1>Index of the <tt>maxdb</tt> module</h1>
316324
<a href="sqlobject/maxdb/maxdbconnection.py.html?f=31&amp;l=34#31">...</a>
317325
<small></small>
318326
<ul>
327+
<li class="routine">
328+
<span class="prefix">f</span>
329+
<a href="class-sqlobject.maxdb.maxdbconnection.LowerBoundOfSliceIsNotSupported.html#__init__">
330+
<tt>__init__</tt>
331+
</a>
332+
<a href="sqlobject/maxdb/maxdbconnection.py.html?f=32&amp;l=34#32">...</a>
333+
<small></small>
334+
</li>
319335
</ul>
320336
</li><li class="class">
321337
<span class="prefix">C</span>
@@ -325,14 +341,6 @@ <h1>Index of the <tt>maxdb</tt> module</h1>
325341
<a href="sqlobject/maxdb/maxdbconnection.py.html?f=53&amp;l=58#53">...</a>
326342
<small></small>
327343
<ul>
328-
<li class="routine">
329-
<span class="prefix">f</span>
330-
<a href="class-sqlobject.maxdb.maxdbconnection.PrimaryKeyNotFounded.html#__init__">
331-
<tt>__init__</tt>
332-
</a>
333-
<a href="sqlobject/maxdb/maxdbconnection.py.html?f=54&amp;l=58#54">...</a>
334-
<small></small>
335-
</li>
336344
</ul>
337345
</li>
338346
</ul>

0 commit comments

Comments
 (0)