Updated documentation

This commit is contained in:
Mike Young
2019-12-01 13:09:41 -05:00
parent db388f4ec6
commit 3337cab11e
148 changed files with 7199 additions and 2107 deletions

50
docs/html/classes.html vendored Executable file → Normal file
View File

@@ -19,7 +19,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">pyShelf Open Source Ebook Server
&#160;<span id="projectnumber">0.1.0</span>
&#160;<span id="projectnumber">0.2.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -44,45 +44,51 @@ $(function() {
<div class="title">Class Index</div> </div>
</div><!--header-->
<div class="contents">
<div class="qindex"><a class="qindex" href="#letter_b">b</a>&#160;|&#160;<a class="qindex" href="#letter_c">c</a>&#160;|&#160;<a class="qindex" href="#letter_d">d</a>&#160;|&#160;<a class="qindex" href="#letter_f">f</a>&#160;|&#160;<a class="qindex" href="#letter_i">i</a>&#160;|&#160;<a class="qindex" href="#letter_r">r</a>&#160;|&#160;<a class="qindex" href="#letter_s">s</a></div>
<div class="qindex"><a class="qindex" href="#letter_b">b</a>&#160;|&#160;<a class="qindex" href="#letter_c">c</a>&#160;|&#160;<a class="qindex" href="#letter_d">d</a>&#160;|&#160;<a class="qindex" href="#letter_i">i</a>&#160;|&#160;<a class="qindex" href="#letter_m">m</a>&#160;|&#160;<a class="qindex" href="#letter_s">s</a>&#160;|&#160;<a class="qindex" href="#letter_t">t</a></div>
<table class="classindex">
<tr><td rowspan="2" valign="bottom"><a name="letter_b"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;b&#160;&#160;</div></td></tr></table>
</td>
<td valign="top"><a class="el" href="classapp_1_1config_1_1Config.html">Config</a> (app.config)&#160;&#160;&#160;</td>
<td rowspan="2" valign="bottom"><a name="letter_i"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;i&#160;&#160;</div></td></tr></table>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">Config</a> (pyShelf.src.backend.lib.config)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html">InterfaceConfig</a> (pyShelf.src.interface.apps)&#160;&#160;&#160;</td>
<td rowspan="2" valign="bottom"><a name="letter_t"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;t&#160;&#160;</div></td></tr></table>
</td>
<td rowspan="2" valign="bottom"><a name="letter_s"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;s&#160;&#160;</div></td></tr></table>
</td>
</tr>
<td></td></tr>
<tr><td rowspan="2" valign="bottom"><a name="letter_d"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;d&#160;&#160;</div></td></tr></table>
</td>
</tr>
<tr><td valign="top"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html">BookDisplay</a> (app.lib.pyShelf)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1InitFiles.html">InitFiles</a> (app.lib.pyShelf)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classapp_1_1lib_1_1storage_1_1Storage.html">Storage</a> (app.lib.storage)&#160;&#160;&#160;</td>
</tr>
<tr><td valign="top"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html">BookServer</a> (app.lib.pyShelf)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">DuckDuckGo</a> (app.lib.api_hooks)&#160;&#160;&#160;</td>
<td rowspan="2" valign="bottom"><a name="letter_r"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;r&#160;&#160;</div></td></tr></table>
<td rowspan="2" valign="bottom"><a name="letter_m"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;m&#160;&#160;</div></td></tr></table>
</td>
<td></td></tr>
<tr><td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">BookDisplay</a> (pyShelf.src.backend.lib.pyShelf)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">Test_Catalogue</a> (pyShelf.src.backend.tests.library_test)&#160;&#160;&#160;</td>
<td></td></tr>
<tr><td valign="top"><a class="el" href="classpyShelf_1_1src_1_1interface_1_1models_1_1Books.html">Books</a> (pyShelf.src.interface.models)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">DuckDuckGo</a> (pyShelf.src.backend.lib.api_hooks)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta.html">Books.Meta</a> (pyShelf.src.interface.models)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html">Test_Config</a> (pyShelf.src.backend.tests.library_test)&#160;&#160;&#160;</td>
<td></td></tr>
<tr><td rowspan="2" valign="bottom"><a name="letter_c"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;c&#160;&#160;</div></td></tr></table>
</td>
<td rowspan="2" valign="bottom"><a name="letter_f"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;f&#160;&#160;</div></td></tr></table>
<td rowspan="2" valign="bottom"><a name="letter_i"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;i&#160;&#160;</div></td></tr></table>
</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.html">Migration</a> (pyShelf.src.interface.migrations.0001_initial)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">TestCatalogue</a> (pyShelf.src.backend.tests.library_test)&#160;&#160;&#160;</td>
<td></td></tr>
<tr><td valign="top"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1RequestHandler.html">RequestHandler</a> (app.lib.pyShelf)&#160;&#160;&#160;</td>
<tr><td rowspan="2" valign="bottom"><a name="letter_s"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;s&#160;&#160;</div></td></tr></table>
</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">TestConfig</a> (pyShelf.src.backend.tests.config_test)&#160;&#160;&#160;</td>
<td></td></tr>
<tr><td valign="top"><a class="el" href="classapp_1_1lib_1_1library_1_1Catalogue.html">Catalogue</a> (app.lib.library)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html">Frontend</a> (app.lib.display)&#160;&#160;&#160;</td>
<tr><td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">Catalogue</a> (pyShelf.src.backend.lib.library)&#160;&#160;&#160;</td>
<td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html">InitFiles</a> (pyShelf.src.backend.lib.pyShelf)&#160;&#160;&#160;</td>
<td></td><td></td></tr>
<tr><td></td><td></td><td></td><td></td></tr>
<tr><td></td><td></td><td valign="top"><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">Storage</a> (pyShelf.src.backend.lib.storage)&#160;&#160;&#160;</td>
<td></td><td></td></tr>
<tr><td></td><td></td><td></td><td></td><td></td></tr>
</table>
<div class="qindex"><a class="qindex" href="#letter_b">b</a>&#160;|&#160;<a class="qindex" href="#letter_c">c</a>&#160;|&#160;<a class="qindex" href="#letter_d">d</a>&#160;|&#160;<a class="qindex" href="#letter_f">f</a>&#160;|&#160;<a class="qindex" href="#letter_i">i</a>&#160;|&#160;<a class="qindex" href="#letter_r">r</a>&#160;|&#160;<a class="qindex" href="#letter_s">s</a></div>
<div class="qindex"><a class="qindex" href="#letter_b">b</a>&#160;|&#160;<a class="qindex" href="#letter_c">c</a>&#160;|&#160;<a class="qindex" href="#letter_d">d</a>&#160;|&#160;<a class="qindex" href="#letter_i">i</a>&#160;|&#160;<a class="qindex" href="#letter_m">m</a>&#160;|&#160;<a class="qindex" href="#letter_s">s</a>&#160;|&#160;<a class="qindex" href="#letter_t">t</a></div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>