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

77
docs/html/functions.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>
@@ -42,74 +42,81 @@ $(function() {
<div class="contents">
<div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div><ul>
<li>__init__()
: <a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#abd77c31f25d1da5035ff7d8aea8c12f9">app.lib.display.Frontend</a>
, <a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html#a01985382ff426043aaabefa7a67524c8">app.lib.pyShelf.BookDisplay</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a0498af17fbd47db504acada242b14fad">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>
</li>
<li>app_body()
: <a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#a8e4f28cd196b0a27f64dcdd98bed0d8c">app.lib.display.Frontend</a>
</li>
<li>app_footer()
: <a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#acb5a0b8033a7117664e2f35a9c14adf0">app.lib.display.Frontend</a>
</li>
<li>app_Headers()
: <a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#aec70f2b0df837439d5888feeb4cf484b">app.lib.display.Frontend</a>
<li>book_paths_list()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a27348bc85856956bade10ec39d51b77e">pyShelf.src.backend.lib.storage.Storage</a>
</li>
<li>booksPerPage()
: <a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html#a6ea053a288f542ca0c22dbb8f4317a7b">app.lib.pyShelf.BookDisplay</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#ac41a7eaf5b19bc7fcbd37c3a82fbcfc9">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>
</li>
<li>close()
: <a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html#a4b038dcd5db1d7ec8b7c66b9a71e09bc">app.lib.pyShelf.BookServer</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#aea7868ca9c943e107e2454871c730555">pyShelf.src.backend.lib.storage.Storage</a>
</li>
<li>close_prompt()
: <a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html#afdf0fe4499eb1e4d462fa24d6f542b90">app.lib.pyShelf.BookServer</a>
<li>commit()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a92c651d41e130c97e73703eb608c82c4">pyShelf.src.backend.lib.storage.Storage</a>
</li>
<li>compile()
: <a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#a8f4d613f2476e124202a62b224d3cc2b">app.lib.display.Frontend</a>
<li>compare_shelf_current()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a1463e646d864f5ee4710bec71990995a">pyShelf.src.backend.lib.library.Catalogue</a>
</li>
<li>create_tables()
: <a class="el" href="classapp_1_1lib_1_1storage_1_1Storage.html#ab8a381a4ce3f5ab9aa070d286d41d6ec">app.lib.storage.Storage</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a7532f4b2a2af0f7100253642f8af4597">pyShelf.src.backend.lib.storage.Storage</a>
</li>
<li>CreateFile()
: <a class="el" href="classapp_1_1lib_1_1pyShelf_1_1InitFiles.html#ade78b7d349aed178101324be3c385df4">app.lib.pyShelf.InitFiles</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html#a614e5bc5f38f75680bba3f1b103c9bb4">pyShelf.src.backend.lib.pyShelf.InitFiles</a>
</li>
<li>database()
: <a class="el" href="classapp_1_1lib_1_1storage_1_1Storage.html#a660085b886b7ceca2870f5d55b98ac7f">app.lib.storage.Storage</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a5c87bc9e650525d30c7fbbee300b5eed">pyShelf.src.backend.lib.storage.Storage</a>
</li>
<li>extract_content()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#aa292917545d1569ddb8caf65577a8a57">pyShelf.src.backend.lib.library.Catalogue</a>
</li>
<li>extract_cover_html()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a4c306bfe05990039b81731992b6f31d6">pyShelf.src.backend.lib.library.Catalogue</a>
</li>
<li>extract_cover_image()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#abeffa733c446b5a367a4225d6a6b5a1e">pyShelf.src.backend.lib.library.Catalogue</a>
</li>
<li>extract_metadata()
: <a class="el" href="classapp_1_1lib_1_1library_1_1Catalogue.html#af6d4779a748534f2b6d2226de791a636">app.lib.library.Catalogue</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a97f42f90efb06225637e28555b37ca01">pyShelf.src.backend.lib.library.Catalogue</a>
</li>
<li>filter_books()
: <a class="el" href="classapp_1_1lib_1_1library_1_1Catalogue.html#a342877aaeeceab24e5ccbb746eb276a9">app.lib.library.Catalogue</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#ab4ba5b4c097789855ded4e7cb05ee0db">pyShelf.src.backend.lib.library.Catalogue</a>
, <a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html#aa2a6c936f7902c6e9287f551fa274edf">pyShelf.src.backend.tests.library_test.Test_Catalogue</a>
</li>
<li>html_Headers()
: <a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#ac024ff106efd6c9dd533fb88a982fa5c">app.lib.display.Frontend</a>
<li>get_absolute_url()
: <a class="el" href="classpyShelf_1_1src_1_1interface_1_1models_1_1Books.html#a6fcf4d27e0e836b224e2a40ef4024ffc">pyShelf.src.interface.models.Books</a>
</li>
<li>image_result()
: <a class="el" href="classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo.html#ab462c2dc90bdabbea4f885dbffb7d8b5">app.lib.api_hooks.DuckDuckGo</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html#a9ecf411b77aca69bee4e1c619b37e521">pyShelf.src.backend.lib.api_hooks.DuckDuckGo</a>
</li>
<li>import_books()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a10be990c40894e3ec45b475e2d89fe96">pyShelf.src.backend.lib.library.Catalogue</a>
</li>
<li>insert_book()
: <a class="el" href="classapp_1_1lib_1_1storage_1_1Storage.html#aeef7a8b53b250749b2147649a32f6ec9">app.lib.storage.Storage</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#ad08ae5682a3e3e66658eee723084fe2a">pyShelf.src.backend.lib.storage.Storage</a>
</li>
<li>nextPage()
: <a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html#af6cc14d26687f8fde0f71c9130993409">app.lib.pyShelf.BookDisplay</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a7a6ed64b1b2f5de6d4b3b21674d61ce2">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>
</li>
<li>open_file()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html#a9dbecd1e259e7bd71ab24b55d4093513">pyShelf.src.backend.lib.config.Config</a>
, <a class="el" href="classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html#ae3bfa4633a2bf86c86d40151b56688b8">pyShelf.src.backend.tests.library_test.Test_Config</a>
</li>
<li>previousPage()
: <a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html#aadf769d9a6b619aa349f321f79a5dea2">app.lib.pyShelf.BookDisplay</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a614c79a2ed8f5c5b0f184858dfebc71e">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>
</li>
<li>process_book()
: <a class="el" href="classapp_1_1lib_1_1library_1_1Catalogue.html#acd24ea8f14df2ef4bdfdb56f5480dea8">app.lib.library.Catalogue</a>
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a84b765167953466756502d0071c69331">pyShelf.src.backend.lib.library.Catalogue</a>
</li>
<li>run()
: <a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html#a6a62aedc980975e37cd10eb6006b18a3">app.lib.pyShelf.BookServer</a>
</li>
<li>scan_book()
: <a class="el" href="classapp_1_1lib_1_1library_1_1Catalogue.html#a91f52410ba00b1472fa91f20162a1e8d">app.lib.library.Catalogue</a>
<li>scan_folder()
: <a class="el" href="classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a5a18784d69536167a50258ce9b1737b1">pyShelf.src.backend.lib.library.Catalogue</a>
</li>
</ul>
</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>