th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Some documentation work

Browse Source
This commit is contained in:
Raelon Masters
2020-08-03 13:04:45 -04:00
parent 1f08dd6d44
commit d8ecd2fab7
68 changed files with 1084 additions and 810 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html
View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.tests.library_test.TestCatalogue Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,16 +19,16 @@
<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.4.1</span>
&#160;<span id="projectnumber">0.6.0</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
<div id="projectbrief">FOSS E-Book Server, https://pyshelf.com</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -75,9 +75,9 @@ Static Public Attributes</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 2 2020 08:12:21 for pyShelf Open Source Ebook Server by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Aug 3 2020 09:02:53 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.17
</a> 1.8.18
</small></address>
</body>
</html>

22
docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html
View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.lib.config.Config Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,16 +19,16 @@
<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.4.1</span>
&#160;<span id="projectnumber">0.6.0</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
<div id="projectbrief">FOSS E-Book Server, https://pyshelf.com</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -70,6 +70,9 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a282f5cb33ebce51fdefdb20b571b7ee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a99caf1885585c5baeacad038272fdb"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html#a2a99caf1885585c5baeacad038272fdb">open_file</a> (self, _cp)</td></tr>
<tr class="separator:a2a99caf1885585c5baeacad038272fdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79655622af458a104e617c1d7e8c8d97"><td class="memItemLeft" align="right" valign="top"><a id="a79655622af458a104e617c1d7e8c8d97"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>django_secret</b> (self, _data)</td></tr>
<tr class="separator:a79655622af458a104e617c1d7e8c8d97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@@ -118,6 +121,9 @@ Public Attributes</h2></td></tr>
<tr class="memitem:a15420665376e4aab800b46e9785a5a95"><td class="memItemLeft" align="right" valign="top"><a id="a15420665376e4aab800b46e9785a5a95"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_pass</b></td></tr>
<tr class="separator:a15420665376e4aab800b46e9785a5a95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace8606bd688c679db6dc0229626d76e5"><td class="memItemLeft" align="right" valign="top"><a id="ace8606bd688c679db6dc0229626d76e5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>SECRET</b></td></tr>
<tr class="separator:ace8606bd688c679db6dc0229626d76e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">Main System Configuration
@@ -148,7 +154,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Initialize main configuration options
</pre>
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
@@ -178,7 +184,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens config.json and reads in configuration options
</pre>
</pre>
<p>Reimplemented in <a class="el" href="../../d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html#a03e5a6c59bffd93c1e81ddc52a84254f">src.backend.tests.library_test.Test_Config</a>.</p>
</div>
@@ -189,9 +195,9 @@ Public Attributes</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 2 2020 08:12:21 for pyShelf Open Source Ebook Server by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Aug 3 2020 09:02:53 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.17
</a> 1.8.18
</small></address>
</body>
</html>