silence warnings from sphinx-build

jeffknupp · Aug 21, 2013 · a27f2d3 · a27f2d3
1 parent 6b64bda
commit a27f2d3
Show file tree

Hide file tree

Showing 16 changed files with 20 additions and 210 deletions.
diff --git a/docs/chinook b/docs/chinook
diff --git a/docs/generated/.doctrees/admin.doctree b/docs/generated/.doctrees/admin.doctree
diff --git a/docs/generated/.doctrees/environment.pickle b/docs/generated/.doctrees/environment.pickle
diff --git a/docs/generated/.doctrees/installation.doctree b/docs/generated/.doctrees/installation.doctree
diff --git a/docs/generated/.doctrees/sandman.doctree b/docs/generated/.doctrees/sandman.doctree
diff --git a/docs/generated/_modules/index.html b/docs/generated/_modules/index.html
@@ -49,7 +49,6 @@ <h1>All modules for which code is available</h1>
 <li><a href="sandman/model.html">sandman.model</a></li>
 <ul><li><a href="sandman/model/models.html">sandman.model.models</a></li>
 </ul><li><a href="sandman/sandman.html">sandman.sandman</a></li>
-<li><a href="sandman/test/test_sandman.html">sandman.test.test_sandman</a></li>
 </ul>
 
           </div>

diff --git a/docs/generated/_modules/sandman/model.html b/docs/generated/_modules/sandman/model.html
@@ -80,7 +80,7 @@ <h1>Source code for sandman.model</h1><div class="highlight"><pre>
                 <span class="n">entry</span><span class="o">.</span><span class="n">_use_admin</span> <span class="o">=</span> <span class="n">use_admin</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="n">current_app</span><span class="o">.</span><span class="n">endpoint_classes</span><span class="p">[</span><span class="n">cls</span><span class="o">.</span><span class="n">endpoint</span><span class="p">()]</span> <span class="o">=</span> <span class="n">cls</span>
-            <span class="n">current_app</span><span class="o">.</span><span class="n">classes_by_name</span><span class="p">(</span><span class="n">cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">cls</span><span class="p">)</span>
+            <span class="n">current_app</span><span class="o">.</span><span class="n">classes_by_name</span><span class="p">[</span><span class="n">cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">]</span> <span class="o">=</span> <span class="n">cls</span>
             <span class="n">cls</span><span class="o">.</span><span class="n">_use_admin</span> <span class="o">=</span> <span class="n">use_admin</span>
     <span class="n">Model</span><span class="o">.</span><span class="n">prepare</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">engine</span><span class="p">)</span>
 </div>

diff --git a/docs/generated/_modules/sandman/model/models.html b/docs/generated/_modules/sandman/model/models.html
@@ -135,9 +135,9 @@ <h1>Source code for sandman.model.models</h1><div class="highlight"><pre>
         <span class="sd">&quot;&quot;&quot;Set a set of attributes which correspond to the</span>
 <span class="sd">        :class:`sandman.model.Model`&#39;s columns.</span>
 
-<span class="sd">        :param dict dictionary: A dictionary of attributes to set on the</span>
-<span class="sd">        instance whose keys are the column names of the</span>
-<span class="sd">        :class:`sandman.model.Model`&#39;s underlying database table.</span>
+<span class="sd">        :param dict dictionary: A dictionary of attributes to set on the instance </span>
+<span class="sd">            whose keys are the column names of </span>
+<span class="sd">            the :class:`sandman.model.Model`&#39;s underlying database table.</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__table__</span><span class="o">.</span><span class="n">columns</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
@@ -151,8 +151,8 @@ <h1>Source code for sandman.model.models</h1><div class="highlight"><pre>
 <span class="sd">        inserting None if an attribute&#39;s value is not specified.</span>
 
 <span class="sd">        :param dict dictionary: A dictionary of attributes to set on the</span>
-<span class="sd">        instance whose keys are the column names of the</span>
-<span class="sd">        :class:`sandman.model.Model`&#39;s underlying database table.</span>
+<span class="sd">            instance whose keys are the column names of the</span>
+<span class="sd">            :class:`sandman.model.Model`&#39;s underlying database table.</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__table__</span><span class="o">.</span><span class="n">columns</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>

diff --git a/docs/generated/genindex.html b/docs/generated/genindex.html
@@ -55,15 +55,13 @@ <h1 id="index">Index</h1>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
- | <a href="#I"><strong>I</strong></a>
  | <a href="#J"><strong>J</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#N"><strong>N</strong></a>
  | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
- | <a href="#T"><strong>T</strong></a>
  | <a href="#U"><strong>U</strong></a>
 
 </div>
@@ -111,12 +109,6 @@ <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
 
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBase.DB_LOCATION">DB_LOCATION (sandman.test.test_sandman.TestSandmanBase attribute)</a>
-  </dt>
-
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
-
   <dt><a href="sandman.html#sandman.sandman.delete_resource">delete_resource() (in module sandman.sandman)</a>
   </dt>
 
@@ -156,24 +148,10 @@ <h2 id="G">G</h2>
   <dt><a href="sandman.html#sandman.exception.JSONException.get_body">get_body() (sandman.exception.JSONException method)</a>
   </dt>
 
-
-  <dt><a href="sandman.html#sandman.exception.JSONException.get_headers">get_headers() (sandman.exception.JSONException method)</a>
-  </dt>
-
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
 
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBase.get_response">get_response() (sandman.test.test_sandman.TestSandmanBase method)</a>
-  </dt>
-
-  </dl></td>
-</tr></table>
-
-<h2 id="I">I</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%" valign="top"><dl>
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBase.is_html_response">is_html_response() (sandman.test.test_sandman.TestSandmanBase static method)</a>
+  <dt><a href="sandman.html#sandman.exception.JSONException.get_headers">get_headers() (sandman.exception.JSONException method)</a>
   </dt>
 
   </dl></td>
@@ -226,10 +204,6 @@ <h2 id="P">P</h2>
   <dt><a href="sandman.html#sandman.sandman.patch_resource">patch_resource() (in module sandman.sandman)</a>
   </dt>
 
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBase.post_response">post_response() (sandman.test.test_sandman.TestSandmanBase method)</a>
-  </dt>
-
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
 
@@ -290,18 +264,10 @@ <h2 id="S">S</h2>
   <dt><a href="sandman.html#module-sandman.model.models">sandman.model.models (module)</a>
   </dt>
 
-
-  <dt><a href="sandman.html#module-sandman.sandman">sandman.sandman (module)</a>
-  </dt>
-
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
 
-  <dt><a href="sandman.test.html#module-sandman.test.test_sandman">sandman.test.test_sandman (module)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBase.setup_method">setup_method() (sandman.test.test_sandman.TestSandmanBase method)</a>
+  <dt><a href="sandman.html#module-sandman.sandman">sandman.sandman (module)</a>
   </dt>
 
 
@@ -315,130 +281,6 @@ <h2 id="S">S</h2>
   </dl></td>
 </tr></table>
 
-<h2 id="T">T</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%" valign="top"><dl>
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBase.teardown_method">teardown_method() (sandman.test.test_sandman.TestSandmanBase method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_delete_non_existant_resource">test_delete_non_existant_resource() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanValidation.test_delete_not_supported">test_delete_not_supported() (sandman.test.test_sandman.TestSandmanValidation method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_delete_resource">test_delete_resource() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_get">test_get() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanContentTypes.test_get_html">test_get_html() (sandman.test.test_sandman.TestSandmanContentTypes method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanContentTypes.test_get_html_collection">test_get_html_collection() (sandman.test.test_sandman.TestSandmanContentTypes method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanContentTypes.test_get_json">test_get_json() (sandman.test.test_sandman.TestSandmanContentTypes method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_patch_existing_resource">test_patch_existing_resource() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_patch_new_resource">test_patch_new_resource() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_post">test_post() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanContentTypes.test_post_html_response">test_post_html_response() (sandman.test.test_sandman.TestSandmanContentTypes method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_posted_location">test_posted_location() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_posted_uri">test_posted_uri() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanUserDefinitions.test_put_fail_validation">test_put_fail_validation() (sandman.test.test_sandman.TestSandmanUserDefinitions method)</a>
-  </dt>
-
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_put_invalid_foreign_key">test_put_invalid_foreign_key() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_put_resource">test_put_resource() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs.test_put_unknown_resource">test_put_unknown_resource() (sandman.test.test_sandman.TestSandmanBasicVerbs method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanValidation.test_unsupported_collection_method">test_unsupported_collection_method() (sandman.test.test_sandman.TestSandmanValidation method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanValidation.test_unsupported_get_resource">test_unsupported_get_resource() (sandman.test.test_sandman.TestSandmanValidation method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanValidation.test_unsupported_patch_resource">test_unsupported_patch_resource() (sandman.test.test_sandman.TestSandmanValidation method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanUserDefinitions.test_user_defined_endpoint">test_user_defined_endpoint() (sandman.test.test_sandman.TestSandmanUserDefinitions method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanUserDefinitions.test_user_validation_accept">test_user_validation_accept() (sandman.test.test_sandman.TestSandmanUserDefinitions method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanUserDefinitions.test_user_validation_reject">test_user_validation_reject() (sandman.test.test_sandman.TestSandmanUserDefinitions method)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBase">TestSandmanBase (class in sandman.test.test_sandman)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanBasicVerbs">TestSandmanBasicVerbs (class in sandman.test.test_sandman)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanContentTypes">TestSandmanContentTypes (class in sandman.test.test_sandman)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanUserDefinitions">TestSandmanUserDefinitions (class in sandman.test.test_sandman)</a>
-  </dt>
-
-
-  <dt><a href="sandman.test.html#sandman.test.test_sandman.TestSandmanValidation">TestSandmanValidation (class in sandman.test.test_sandman)</a>
-  </dt>
-
-  </dl></td>
-</tr></table>
-
 <h2 id="U">U</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>

diff --git a/docs/generated/objects.inv b/docs/generated/objects.inv
diff --git a/docs/generated/py-modindex.html b/docs/generated/py-modindex.html
@@ -84,11 +84,6 @@ <h1>Python Module Index</h1>
        <td>&nbsp;&nbsp;&nbsp;
        <a href="sandman.html#module-sandman.sandman"><tt class="xref">sandman.sandman</tt></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-1">
-       <td></td>
-       <td>&nbsp;&nbsp;&nbsp;
-       <a href="sandman.test.html#module-sandman.test.test_sandman"><tt class="xref">sandman.test.test_sandman</tt></a></td><td>
-       <em></em></td></tr>
    </table>
 
 

diff --git a/docs/generated/sandman.html b/docs/generated/sandman.html
@@ -169,12 +169,12 @@ <h1>sandman API<a class="headerlink" href="#sandman-api" title="Permalink to thi
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dictionary</strong> (<em>dict</em>) &#8211; A dictionary of attributes to set on the</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dictionary</strong> (<em>dict</em>) &#8211; A dictionary of attributes to set on the instance 
+whose keys are the column names of 
+the <tt class="xref py py-class docutils literal"><span class="pre">sandman.model.Model</span></tt>&#8216;s underlying database table.</td>
 </tr>
 </tbody>
 </table>
-<p>instance whose keys are the column names of the
-<tt class="xref py py-class docutils literal"><span class="pre">sandman.model.Model</span></tt>&#8216;s underlying database table.</p>
 </dd></dl>
 
 <dl class="method">
@@ -207,12 +207,12 @@ <h1>sandman API<a class="headerlink" href="#sandman-api" title="Permalink to thi
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dictionary</strong> (<em>dict</em>) &#8211; A dictionary of attributes to set on the</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dictionary</strong> (<em>dict</em>) &#8211; A dictionary of attributes to set on the
+instance whose keys are the column names of the
+<tt class="xref py py-class docutils literal"><span class="pre">sandman.model.Model</span></tt>&#8216;s underlying database table.</td>
 </tr>
 </tbody>
 </table>
-<p>instance whose keys are the column names of the
-<tt class="xref py py-class docutils literal"><span class="pre">sandman.model.Model</span></tt>&#8216;s underlying database table.</p>
 </dd></dl>
 
 <dl class="method">