[doc] Included built docs

doc/build/html/_sources/index.txt

@@ -11,6 +11,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   README
    api/accounting.rst
 
 

doc/build/html/api/accounting.html

@@ -164,13 +164,8 @@ jsonify_exceptions decorator</p>
 <dd></dd></dl>
 
 <dl class="method">
-<dt id="accounting.gtkclient.AccountingApplication.on_aboutdialog_close">
-<tt class="descname">on_aboutdialog_close</tt><big>(</big><em>widget</em><big>)</big><a class="reference internal" href="../_modules/accounting/gtkclient.html#AccountingApplication.on_aboutdialog_close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.gtkclient.AccountingApplication.on_aboutdialog_close" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="accounting.gtkclient.AccountingApplication.on_refresh_transactions_activate">
-<tt class="descname">on_refresh_transactions_activate</tt><big>(</big><em>widget</em><big>)</big><a class="reference internal" href="../_modules/accounting/gtkclient.html#AccountingApplication.on_refresh_transactions_activate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.gtkclient.AccountingApplication.on_refresh_transactions_activate" title="Permalink to this definition">¶</a></dt>
+<dt id="accounting.gtkclient.AccountingApplication.on_about_dialog_response">
+<tt class="descname">on_about_dialog_response</tt><big>(</big><em>widget</em>, <em>response_type</em><big>)</big><a class="headerlink" href="#accounting.gtkclient.AccountingApplication.on_about_dialog_response" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="method">
@@ -179,8 +174,13 @@ jsonify_exceptions decorator</p>
 <dd></dd></dl>
 
 <dl class="method">
-<dt id="accounting.gtkclient.AccountingApplication.on_transaction_selected">
-<tt class="descname">on_transaction_selected</tt><big>(</big><em>widget</em><big>)</big><a class="reference internal" href="../_modules/accounting/gtkclient.html#AccountingApplication.on_transaction_selected"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.gtkclient.AccountingApplication.on_transaction_selected" title="Permalink to this definition">¶</a></dt>
+<dt id="accounting.gtkclient.AccountingApplication.on_transaction_refresh_activate">
+<tt class="descname">on_transaction_refresh_activate</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#accounting.gtkclient.AccountingApplication.on_transaction_refresh_activate" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="accounting.gtkclient.AccountingApplication.on_transaction_view_cursor_changed">
+<tt class="descname">on_transaction_view_cursor_changed</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#accounting.gtkclient.AccountingApplication.on_transaction_view_cursor_changed" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="method">

doc/build/html/api/accounting.storage.html

@@ -99,6 +99,11 @@ based on <tt class="xref py py-attr docutils literal"><span class="pre">self.led
 <tt class="descname">bal</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/accounting/storage/ledgercli.html#Ledger.bal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.ledgercli.Ledger.bal" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="method">
+<dt id="accounting.storage.ledgercli.Ledger.delete_transaction">
+<tt class="descname">delete_transaction</tt><big>(</big><em>transaction_id</em><big>)</big><a class="headerlink" href="#accounting.storage.ledgercli.Ledger.delete_transaction" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="method">
 <dt id="accounting.storage.ledgercli.Ledger.get_process">
 <tt class="descname">get_process</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/accounting/storage/ledgercli.html#Ledger.get_process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.ledgercli.Ledger.get_process" title="Permalink to this definition">¶</a></dt>
@@ -107,6 +112,11 @@ based on <tt class="xref py py-attr docutils literal"><span class="pre">self.led
 <a class="reference internal" href="#accounting.storage.ledgercli.Ledger.init_process" title="accounting.storage.ledgercli.Ledger.init_process"><tt class="xref py py-meth docutils literal"><span class="pre">self.init_process()</span></tt></a> is returned.</p>
 </dd></dl>
 
+<dl class="method">
+<dt id="accounting.storage.ledgercli.Ledger.get_transaction">
+<tt class="descname">get_transaction</tt><big>(</big><em>transaction_id</em><big>)</big><a class="headerlink" href="#accounting.storage.ledgercli.Ledger.get_transaction" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="method">
 <dt id="accounting.storage.ledgercli.Ledger.get_transactions">
 <tt class="descname">get_transactions</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/accounting/storage/ledgercli.html#Ledger.get_transactions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.ledgercli.Ledger.get_transactions" title="Permalink to this definition">¶</a></dt>
@@ -175,6 +185,11 @@ without the prompt.</p>
 <em class="property">class </em><tt class="descclassname">accounting.storage.</tt><tt class="descname">Storage</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage.html#Storage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.Storage" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">builtins.object</span></tt></p>
 <p>ABC for accounting storage</p>
+<dl class="method">
+<dt id="accounting.storage.Storage.add_transaction">
+<tt class="descname">add_transaction</tt><big>(</big><em>transaction</em><big>)</big><a class="headerlink" href="#accounting.storage.Storage.add_transaction" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="method">
 <dt id="accounting.storage.Storage.get_account">
 <tt class="descname">get_account</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/accounting/storage.html#Storage.get_account"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#accounting.storage.Storage.get_account" title="Permalink to this definition">¶</a></dt>
@@ -207,6 +222,12 @@ without the prompt.</p>
 
 </dd></dl>
 
+<dl class="exception">
+<dt id="accounting.storage.TransactionNotFound">
+<em class="property">exception </em><tt class="descclassname">accounting.storage.</tt><tt class="descname">TransactionNotFound</tt><a class="headerlink" href="#accounting.storage.TransactionNotFound" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="accounting.html#accounting.exceptions.AccountingException" title="accounting.exceptions.AccountingException"><tt class="xref py py-class docutils literal"><span class="pre">accounting.exceptions.AccountingException</span></tt></a></p>
+</dd></dl>
+
 </div>
 </div>
 

doc/build/html/genindex.html

@@ -153,6 +153,10 @@
 
       <dd><dl>
         
+  <dt><a href="api/accounting.storage.html#accounting.storage.Storage.add_transaction">(accounting.storage.Storage method)</a>
+  </dt>
+
+        
   <dt><a href="api/accounting.storage.sql.html#accounting.storage.sql.SQLStorage.add_transaction">(accounting.storage.sql.SQLStorage method)</a>
   </dt>
 
@@ -236,6 +240,10 @@
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
       
+  <dt><a href="api/accounting.storage.html#accounting.storage.ledgercli.Ledger.delete_transaction">delete_transaction() (accounting.storage.ledgercli.Ledger method)</a>
+  </dt>
+
+      
   <dt><a href="api/accounting.html#accounting.transport.AccountingDecoder.dict_to_object">dict_to_object() (accounting.transport.AccountingDecoder method)</a>
   </dt>
 
@@ -276,9 +284,15 @@
   </dt>
 
       
-  <dt><a href="api/accounting.storage.html#accounting.storage.Storage.get_transaction">get_transaction() (accounting.storage.Storage method)</a>
+  <dt><a href="api/accounting.storage.html#accounting.storage.ledgercli.Ledger.get_transaction">get_transaction() (accounting.storage.ledgercli.Ledger method)</a>
   </dt>
 
+      <dd><dl>
+        
+  <dt><a href="api/accounting.storage.html#accounting.storage.Storage.get_transaction">(accounting.storage.Storage method)</a>
+  </dt>
+
+      </dl></dd>
       
   <dt><a href="api/accounting.storage.html#accounting.storage.ledgercli.Ledger.get_transactions">get_transactions() (accounting.storage.ledgercli.Ledger method)</a>
   </dt>
@@ -408,21 +422,21 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
       
-  <dt><a href="api/accounting.html#accounting.gtkclient.AccountingApplication.on_aboutdialog_close">on_aboutdialog_close() (accounting.gtkclient.AccountingApplication method)</a>
-  </dt>
-
-      
-  <dt><a href="api/accounting.html#accounting.gtkclient.AccountingApplication.on_refresh_transactions_activate">on_refresh_transactions_activate() (accounting.gtkclient.AccountingApplication method)</a>
+  <dt><a href="api/accounting.html#accounting.gtkclient.AccountingApplication.on_about_dialog_response">on_about_dialog_response() (accounting.gtkclient.AccountingApplication method)</a>
   </dt>
 
       
   <dt><a href="api/accounting.html#accounting.gtkclient.AccountingApplication.on_show_about_activate">on_show_about_activate() (accounting.gtkclient.AccountingApplication method)</a>
   </dt>
 
+      
+  <dt><a href="api/accounting.html#accounting.gtkclient.AccountingApplication.on_transaction_refresh_activate">on_transaction_refresh_activate() (accounting.gtkclient.AccountingApplication method)</a>
+  </dt>
+
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
       
-  <dt><a href="api/accounting.html#accounting.gtkclient.AccountingApplication.on_transaction_selected">on_transaction_selected() (accounting.gtkclient.AccountingApplication method)</a>
+  <dt><a href="api/accounting.html#accounting.gtkclient.AccountingApplication.on_transaction_view_cursor_changed">on_transaction_view_cursor_changed() (accounting.gtkclient.AccountingApplication method)</a>
   </dt>
 
       
@@ -535,12 +549,12 @@
   <dt><a href="api/accounting.html#accounting.web.transaction_get">transaction_get() (in module accounting.web)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
       
   <dt><a href="api/accounting.html#accounting.web.transaction_post">transaction_post() (in module accounting.web)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
       
   <dt><a href="api/accounting.html#accounting.web.transaction_update">transaction_update() (in module accounting.web)</a>
   </dt>
@@ -549,6 +563,10 @@
   <dt><a href="api/accounting.storage.sql.html#accounting.storage.sql.models.Posting.transaction_uuid">transaction_uuid (accounting.storage.sql.models.Posting attribute)</a>
   </dt>
 
+      
+  <dt><a href="api/accounting.storage.html#accounting.storage.TransactionNotFound">TransactionNotFound</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 

doc/build/html/index.html

@@ -24,7 +24,7 @@
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
     <link rel="top" title="Accounting API 0.1-beta documentation" href="#" />
-    <link rel="next" title="accounting package" href="api/accounting.html" /> 
+    <link rel="next" title="The Accounting API" href="README.html" /> 
   </head>
   <body>
     <div class="related">
@@ -37,7 +37,7 @@
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="api/accounting.html" title="accounting package"
+          <a href="README.html" title="The Accounting API"
              accesskey="N">next</a> |</li>
         <li><a href="#">Accounting API 0.1-beta documentation</a> &raquo;</li> 
       </ul>
@@ -53,6 +53,12 @@
 <p>Contents:</p>
 <div class="toctree-wrapper compound">
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="README.html">The Accounting API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="README.html#dependencies">Dependencies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#installation-i-e-development-setup">Installation (i.e. Development Setup)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#usage">Usage</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="api/accounting.html">accounting package</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="api/accounting.html#subpackages">Subpackages</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/accounting.html#submodules">Submodules</a></li>
@@ -94,8 +100,8 @@
 </ul>
 
   <h4>Next topic</h4>
-  <p class="topless"><a href="api/accounting.html"
-                        title="next chapter">accounting package</a></p>
+  <p class="topless"><a href="README.html"
+                        title="next chapter">The Accounting API</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="_sources/index.txt"
@@ -128,7 +134,7 @@
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="api/accounting.html" title="accounting package"
+          <a href="README.html" title="The Accounting API"
              >next</a> |</li>
         <li><a href="#">Accounting API 0.1-beta documentation</a> &raquo;</li> 
       </ul>