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

31
docs/html/hierarchy.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>
@@ -46,22 +46,29 @@ $(function() {
<div class="contents">
<div class="textblock">This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html" target="_self">app.lib.pyShelf.BookDisplay</a></td><td class="desc"></td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html" target="_self">app.lib.pyShelf.BookServer</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1lib_1_1library_1_1Catalogue.html" target="_self">app.lib.library.Catalogue</a></td><td class="desc"></td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1config_1_1Config.html" target="_self">app.config.Config</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo.html" target="_self">app.lib.api_hooks.DuckDuckGo</a></td><td class="desc"></td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html" target="_self">app.lib.display.Frontend</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1InitFiles.html" target="_self">app.lib.pyShelf.InitFiles</a></td><td class="desc"></td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1lib_1_1storage_1_1Storage.html" target="_self">app.lib.storage.Storage</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_8_" class="arrow" onclick="toggleFolder('8_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>BaseHTTPRequestHandler</b></td><td class="desc"></td></tr>
<tr id="row_8_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1RequestHandler.html" target="_self">app.lib.pyShelf.RequestHandler</a></td><td class="desc"></td></tr>
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html" target="_self">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="desc"></td></tr>
<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html" target="_self">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="desc"></td></tr>
<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html" target="_self">pyShelf.src.backend.tests.library_test.Test_Catalogue</a></td><td class="desc"></td></tr>
<tr id="row_2_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html" target="_self">pyShelf.src.backend.lib.config.Config</a></td><td class="desc"></td></tr>
<tr id="row_2_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html" target="_self">pyShelf.src.backend.tests.library_test.Test_Config</a></td><td class="desc"></td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html" target="_self">pyShelf.src.backend.lib.api_hooks.DuckDuckGo</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html" target="_self">pyShelf.src.backend.lib.pyShelf.InitFiles</a></td><td class="desc"></td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta.html" target="_self">pyShelf.src.interface.models.Books.Meta</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_6_" class="arrow" onclick="toggleFolder('6_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>Migration</b></td><td class="desc"></td></tr>
<tr id="row_6_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.html" target="_self">pyShelf.src.interface.migrations.0001_initial.Migration</a></td><td class="desc"></td></tr>
<tr id="row_7_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_7_" class="arrow" onclick="toggleFolder('7_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>Model</b></td><td class="desc"></td></tr>
<tr id="row_7_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1interface_1_1models_1_1Books.html" target="_self">pyShelf.src.interface.models.Books</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html" target="_self">pyShelf.src.backend.lib.storage.Storage</a></td><td class="desc"></td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html" target="_self">pyShelf.src.backend.tests.library_test.TestCatalogue</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html" target="_self">pyShelf.src.backend.tests.config_test.TestConfig</a></td><td class="desc"></td></tr>
<tr id="row_11_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_11_" class="arrow" onclick="toggleFolder('11_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>AppConfig</b></td><td class="desc"></td></tr>
<tr id="row_11_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html" target="_self">pyShelf.src.interface.apps.InterfaceConfig</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</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>