Update devel docs

Author: phdru

devel/News.html

@@ -62,7 +62,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
 <li><a class="reference internal" href="#sqlobject-3-2-0-master">SQLObject 3.2.0 (master)</a><ul>
 <li><a class="reference internal" href="#minor-features">Minor features</a></li>
 <li><a class="reference internal" href="#drivers-work-in-progress">Drivers (work in progress)</a></li>
-<li><a class="reference internal" href="#bug-fix">Bug fix</a></li>
+<li><a class="reference internal" href="#bug-fixes">Bug fixes</a></li>
 <li><a class="reference internal" href="#documentation">Documentation</a></li>
 <li><a class="reference internal" href="#tests">Tests</a></li>
 </ul>
@@ -125,7 +125,7 @@ <h1>News<a class="headerlink" href="#news" title="Permalink to this headline">¶
 <li><a class="reference internal" href="#sqlobject-3-2-0-master" id="id8">SQLObject 3.2.0 (master)</a><ul>
 <li><a class="reference internal" href="#minor-features" id="id9">Minor features</a></li>
 <li><a class="reference internal" href="#drivers-work-in-progress" id="id10">Drivers (work in progress)</a></li>
-<li><a class="reference internal" href="#bug-fix" id="id11">Bug fix</a></li>
+<li><a class="reference internal" href="#bug-fixes" id="id11">Bug fixes</a></li>
 <li><a class="reference internal" href="#documentation" id="id12">Documentation</a></li>
 <li><a class="reference internal" href="#tests" id="id13">Tests</a></li>
 </ul>
@@ -158,9 +158,9 @@ <h3>Minor features<a class="headerlink" href="#minor-features" title="Permalink
 the name of the attached database to vacuum.</li>
 <li>Remove <code class="docutils literal"><span class="pre">driver</span></code> keyword from RdbhostConnection as it allows one driver
 <code class="docutils literal"><span class="pre">rdbhdb</span></code>.</li>
-<li>Add <code class="docutils literal"><span class="pre">driver</span></code> keyword for FirebirdConnection. Allowed values are &#8216;fdb&#8217;
-or &#8216;kinterbasdb&#8217;. Default is to test &#8216;fdb&#8217; and &#8216;kinterbasdb&#8217; in that
-order. pyfirebirdsql is supported but has problems.</li>
+<li>Add <code class="docutils literal"><span class="pre">driver</span></code> keyword for FirebirdConnection. Allowed values are &#8216;fdb&#8217;,
+&#8216;kinterbasdb&#8217; and &#8216;pyfirebirdsql&#8217;. Default is to test &#8216;fdb&#8217; and
+&#8216;kinterbasdb&#8217; in that order. pyfirebirdsql is supported but has problems.</li>
 <li>Add <code class="docutils literal"><span class="pre">driver</span></code> keyword for MySQLConnection. Allowed value are &#8216;mysqldb&#8217;,
 &#8216;connector&#8217;, &#8216;oursql&#8217; and &#8216;pymysql&#8217;. Default is to test for mysqldb only.</li>
 <li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/mysql-connector">MySQL Connector</a> (pure python; <a class="reference external" href="https://dev.mysql.com/doc/connector-python/en/">binary
@@ -183,13 +183,15 @@ <h3>Drivers (work in progress)<a class="headerlink" href="#drivers-work-in-progr
 <li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/pg8000">pg8000</a>
 PostgreSQL driver. There are major problems with the driver caused by both
 the driver and SQLObject.</li>
-<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a>.</li>
+<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a>.There are still problems with
+the driver.</li>
 </ul>
 </div>
-<div class="section" id="bug-fix">
-<h3>Bug fix<a class="headerlink" href="#bug-fix" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="bug-fixes">
+<h3>Bug fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li>Fix MSSQLConnection.columnsFromSchema: remove () from default value.</li>
+<li>Fix MSSQLConnection.columnsFromSchema: remove <cite>(</cite> and <cite>)</cite> from default
+value.</li>
 <li>Fix MSSQLConnection and SybaseConnection: insert default values into a table
 with just one IDENTITY column.</li>
 <li>Remove excessive NULLs for MSSQL/Sybase.</li>
@@ -213,13 +215,12 @@ <h3>Tests<a class="headerlink" href="#tests" title="Permalink to this headline">
 to <code class="docutils literal"><span class="pre">SOTestXXX</span></code> to prevent <code class="docutils literal"><span class="pre">pytest</span></code> to recognize them as test classes.</li>
 <li>Fix <code class="docutils literal"><span class="pre">pytest</span></code> warnings by converting yield tests to plain calls: yield
 tests were deprecated in <code class="docutils literal"><span class="pre">pytest</span></code>.</li>
-<li>Tests are now run at CIs with <code class="docutils literal"><span class="pre">python3.5</span></code>.</li>
+<li>Tests are now run at CIs with Python 3.5.</li>
 <li>Drop <code class="docutils literal"><span class="pre">Circle</span> <span class="pre">CI</span></code>.</li>
 <li>Run at Travis CI tests with Firebird backend (server version 2.5; drivers fdb
 and firebirdsql). There are problems with tests.</li>
-<li>Add AppVeyor for windows testing. Run tests with Postgres and MS SQL. There
-are problems with MS SQL.</li>
-<li>Run sqlite tests at AppVeyor.</li>
+<li>Add AppVeyor for windows testing. Run tests with MS SQL, Postgres and
+SQLite. There are problems with MS SQL.</li>
 </ul>
 </div>
 </div>

devel/SQLObject.html

@@ -316,9 +316,9 @@ <h2><a class="toc-backref" href="#id13">Requirements</a><a class="headerlink" hr
 <a class="reference external" href="https://postgresql.org">PostgreSQL</a> <a class="reference external" href="http://initd.org/psycopg/">psycopg2</a> or psycopg1 are recommended; <a class="reference external" href="http://www.pygresql.org/">PyGreSQL</a>, <a class="reference external" href="https://pypi.python.org/pypi/py-postgresql">py-postgresql</a>
 and <a class="reference external" href="https://pypi.python.org/pypi/pg8000">pg8000</a> are supported but have problems (not all tests passed). <a class="reference external" href="https://sqlite.org/">SQLite</a> has
 a built-in driver or <a class="reference external" href="https://github.com/ghaering/pysqlite">PySQLite</a>. <a class="reference external" href="http://www.firebirdsql.org/en/python-driver/">Firebird</a> is supported via <a class="reference external" href="http://www.firebirdsql.org/en/devel-python-driver/">fdb</a> or
-<a class="reference external" href="http://kinterbasdb.sourceforge.net/">kinterbasdb</a>; <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a> is supported but untested. <a class="reference external" href="http://maxdb.sap.com/">MAX DB</a> (also known
-as SAP DB) is supported via <a class="reference external" href="http://maxdb.sap.com/doc/7_8/50/01923f25b842438a408805774f6989/frameset.htm">sapdb</a>. Sybase via <a class="reference external" href="http://www.object-craft.com.au/projects/sybase/">Sybase</a>. <a class="reference external" href="http://www.microsoft.com/sql/">MSSQL Server</a> via
-<a class="reference external" href="http://www.pymssql.org/en/latest/index.html">pymssql</a> (+ <a class="reference external" href="http://www.freetds.org/">FreeTDS</a>) or <a class="reference external" href="http://adodbapi.sourceforge.net/">adodbapi</a> (Win32).</p>
+<a class="reference external" href="http://kinterbasdb.sourceforge.net/">kinterbasdb</a>; <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a> is supported but has problems. <a class="reference external" href="http://maxdb.sap.com/">MAX DB</a> (also
+known as SAP DB) is supported via <a class="reference external" href="http://maxdb.sap.com/doc/7_8/50/01923f25b842438a408805774f6989/frameset.htm">sapdb</a>. Sybase via <a class="reference external" href="http://www.object-craft.com.au/projects/sybase/">Sybase</a>. <a class="reference external" href="http://www.microsoft.com/sql/">MSSQL Server</a>
+via <a class="reference external" href="http://www.pymssql.org/en/latest/index.html">pymssql</a> (+ <a class="reference external" href="http://www.freetds.org/">FreeTDS</a>) or <a class="reference external" href="http://adodbapi.sourceforge.net/">adodbapi</a> (Win32).</p>
 <p>Python 2.6, 2.7 or 3.4+ is required.</p>
 </div>
 <div class="section" id="compared-to-other-database-wrappers">

devel/_modules/sqlobject/tests/test_mysql.html

@@ -74,21 +74,25 @@ <h1>Source code for sqlobject.tests.test_mysql</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">sqlobject.tests.dbtest</span> <span class="k">import</span> <span class="n">getConnection</span><span class="p">,</span> <span class="n">setupClass</span>
 
 
+<span class="k">try</span><span class="p">:</span>
+    <span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
+<span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">NameError</span><span class="p">):</span>
+    <span class="c1"># The module was imported during documentation building</span>
+    <span class="k">pass</span>
+<span class="k">else</span><span class="p">:</span>
+    <span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;mysql&quot;</span><span class="p">:</span>
+        <span class="n">pytestmark</span> <span class="o">=</span> <span class="n">pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
+
+
 <div class="viewcode-block" id="SOTestSOListMySQL"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_mysql.html#sqlobject.tests.test_mysql.SOTestSOListMySQL">[docs]</a><span class="k">class</span> <span class="nc">SOTestSOListMySQL</span><span class="p">(</span><span class="n">SQLObject</span><span class="p">):</span>
     <span class="k">pass</span></div>
 
 
 <div class="viewcode-block" id="test_list_databases"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_mysql.html#sqlobject.tests.test_mysql.test_list_databases">[docs]</a><span class="k">def</span> <span class="nf">test_list_databases</span><span class="p">():</span>
-    <span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
-    <span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;mysql&quot;</span><span class="p">:</span>
-        <span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;These tests require MySQL&quot;</span><span class="p">)</span>
     <span class="k">assert</span> <span class="n">connection</span><span class="o">.</span><span class="n">db</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">listDatabases</span><span class="p">()</span></div>
 
 
 <div class="viewcode-block" id="test_list_tables"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_mysql.html#sqlobject.tests.test_mysql.test_list_tables">[docs]</a><span class="k">def</span> <span class="nf">test_list_tables</span><span class="p">():</span>
-    <span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
-    <span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;mysql&quot;</span><span class="p">:</span>
-        <span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;These tests require MySQL&quot;</span><span class="p">)</span>
     <span class="n">setupClass</span><span class="p">(</span><span class="n">SOTestSOListMySQL</span><span class="p">)</span>
     <span class="k">assert</span> <span class="n">SOTestSOListMySQL</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">table</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">listTables</span><span class="p">()</span></div>
 </pre></div>

devel/_modules/sqlobject/tests/test_postgres.html

@@ -80,15 +80,24 @@ <h1>Source code for sqlobject.tests.test_postgres</h1><div class="highlight"><pr
 <span class="c1">########################################</span>
 
 
+<span class="k">try</span><span class="p">:</span>
+    <span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
+<span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">NameError</span><span class="p">):</span>
+    <span class="c1"># The module was imported during documentation building</span>
+    <span class="k">pass</span>
+<span class="k">else</span><span class="p">:</span>
+    <span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;postgres&quot;</span><span class="p">:</span>
+        <span class="n">pytestmark</span> <span class="o">=</span> <span class="n">pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
+
+
 <div class="viewcode-block" id="SOTestSSLMode"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_postgres.html#sqlobject.tests.test_postgres.SOTestSSLMode">[docs]</a><span class="k">class</span> <span class="nc">SOTestSSLMode</span><span class="p">(</span><span class="n">SQLObject</span><span class="p">):</span>
     <span class="n">test</span> <span class="o">=</span> <span class="n">StringCol</span><span class="p">()</span></div>
 
 
 <div class="viewcode-block" id="test_sslmode"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_postgres.html#sqlobject.tests.test_postgres.test_sslmode">[docs]</a><span class="k">def</span> <span class="nf">test_sslmode</span><span class="p">():</span>
     <span class="n">setupClass</span><span class="p">(</span><span class="n">SOTestSSLMode</span><span class="p">)</span>
     <span class="n">connection</span> <span class="o">=</span> <span class="n">SOTestSSLMode</span><span class="o">.</span><span class="n">_connection</span>
-    <span class="k">if</span> <span class="p">(</span><span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s1">&#39;postgres&#39;</span><span class="p">)</span> <span class="ow">or</span> \
-            <span class="p">(</span><span class="ow">not</span> <span class="n">connection</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">__name__</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;psycopg&#39;</span><span class="p">))</span> <span class="ow">or</span> \
+    <span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="n">connection</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">__name__</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;psycopg&#39;</span><span class="p">))</span> <span class="ow">or</span> \
             <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">&#39;nt&#39;</span><span class="p">):</span>
         <span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;The test requires PostgreSQL, psycopg and ssl mode; &quot;</span>
                     <span class="s2">&quot;also it doesn&#39;t work on w32&quot;</span><span class="p">)</span>
@@ -112,16 +121,10 @@ <h1>Source code for sqlobject.tests.test_postgres</h1><div class="highlight"><pr
 
 
 <div class="viewcode-block" id="test_list_databases"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_postgres.html#sqlobject.tests.test_postgres.test_list_databases">[docs]</a><span class="k">def</span> <span class="nf">test_list_databases</span><span class="p">():</span>
-    <span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
-    <span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;postgres&quot;</span><span class="p">:</span>
-        <span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;These tests require PostgreSQL&quot;</span><span class="p">)</span>
     <span class="k">assert</span> <span class="n">connection</span><span class="o">.</span><span class="n">db</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">listDatabases</span><span class="p">()</span></div>
 
 
 <div class="viewcode-block" id="test_list_tables"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_postgres.html#sqlobject.tests.test_postgres.test_list_tables">[docs]</a><span class="k">def</span> <span class="nf">test_list_tables</span><span class="p">():</span>
-    <span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
-    <span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;postgres&quot;</span><span class="p">:</span>
-        <span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;These tests require PostgreSQL&quot;</span><span class="p">)</span>
     <span class="n">setupClass</span><span class="p">(</span><span class="n">SOTestSOList</span><span class="p">)</span>
     <span class="k">assert</span> <span class="n">SOTestSOList</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">table</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">listTables</span><span class="p">()</span></div>
 </pre></div>