Documentation generation

This commit is contained in:
Maxim Stewart 2020-04-11 15:39:42 -05:00
parent 843d73ff43
commit ee241da4d0
8 changed files with 317 additions and 0 deletions

99
docs/__main__.html Normal file
View File

@ -0,0 +1,99 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module __main__</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>__main__</strong></big></big> (26 February 2001)</font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python3.6/pydoc.py">/usr/lib/python3.6/pydoc.py</a><br><a href="https://docs.python.org/3.6/library/__main__">Module Reference</a></font></td></tr></table>
<p><tt>Generate&nbsp;Python&nbsp;documentation&nbsp;in&nbsp;HTML&nbsp;or&nbsp;text&nbsp;for&nbsp;interactive&nbsp;use.<br>
&nbsp;<br>
At&nbsp;the&nbsp;Python&nbsp;interactive&nbsp;prompt,&nbsp;calling&nbsp;help(thing)&nbsp;on&nbsp;a&nbsp;Python&nbsp;object<br>
documents&nbsp;the&nbsp;object,&nbsp;and&nbsp;calling&nbsp;help()&nbsp;starts&nbsp;up&nbsp;an&nbsp;interactive<br>
help&nbsp;session.<br>
&nbsp;<br>
Or,&nbsp;at&nbsp;the&nbsp;shell&nbsp;command&nbsp;line&nbsp;outside&nbsp;of&nbsp;Python:<br>
&nbsp;<br>
Run&nbsp;"pydoc&nbsp;&lt;name&gt;"&nbsp;to&nbsp;show&nbsp;documentation&nbsp;on&nbsp;something.&nbsp;&nbsp;&lt;name&gt;&nbsp;may&nbsp;be<br>
the&nbsp;name&nbsp;of&nbsp;a&nbsp;function,&nbsp;module,&nbsp;package,&nbsp;or&nbsp;a&nbsp;dotted&nbsp;reference&nbsp;to&nbsp;a<br>
class&nbsp;or&nbsp;function&nbsp;within&nbsp;a&nbsp;module&nbsp;or&nbsp;module&nbsp;in&nbsp;a&nbsp;package.&nbsp;&nbsp;If&nbsp;the<br>
argument&nbsp;contains&nbsp;a&nbsp;path&nbsp;segment&nbsp;delimiter&nbsp;(e.g.&nbsp;slash&nbsp;on&nbsp;Unix,<br>
backslash&nbsp;on&nbsp;Windows)&nbsp;it&nbsp;is&nbsp;treated&nbsp;as&nbsp;the&nbsp;path&nbsp;to&nbsp;a&nbsp;Python&nbsp;source&nbsp;file.<br>
&nbsp;<br>
Run&nbsp;"pydoc&nbsp;-k&nbsp;&lt;keyword&gt;"&nbsp;to&nbsp;search&nbsp;for&nbsp;a&nbsp;keyword&nbsp;in&nbsp;the&nbsp;synopsis&nbsp;lines<br>
of&nbsp;all&nbsp;available&nbsp;modules.<br>
&nbsp;<br>
Run&nbsp;"pydoc&nbsp;-p&nbsp;&lt;port&gt;"&nbsp;to&nbsp;start&nbsp;an&nbsp;HTTP&nbsp;server&nbsp;on&nbsp;the&nbsp;given&nbsp;port&nbsp;on&nbsp;the<br>
local&nbsp;machine.&nbsp;&nbsp;Port&nbsp;number&nbsp;0&nbsp;can&nbsp;be&nbsp;used&nbsp;to&nbsp;get&nbsp;an&nbsp;arbitrary&nbsp;unused&nbsp;port.<br>
&nbsp;<br>
Run&nbsp;"pydoc&nbsp;-b"&nbsp;to&nbsp;start&nbsp;an&nbsp;HTTP&nbsp;server&nbsp;on&nbsp;an&nbsp;arbitrary&nbsp;unused&nbsp;port&nbsp;and<br>
open&nbsp;a&nbsp;Web&nbsp;browser&nbsp;to&nbsp;interactively&nbsp;browse&nbsp;documentation.&nbsp;&nbsp;The&nbsp;-p&nbsp;option<br>
can&nbsp;be&nbsp;used&nbsp;with&nbsp;the&nbsp;-b&nbsp;option&nbsp;to&nbsp;explicitly&nbsp;specify&nbsp;the&nbsp;server&nbsp;port.<br>
&nbsp;<br>
Run&nbsp;"pydoc&nbsp;-w&nbsp;&lt;name&gt;"&nbsp;to&nbsp;write&nbsp;out&nbsp;the&nbsp;HTML&nbsp;documentation&nbsp;for&nbsp;a&nbsp;module<br>
to&nbsp;a&nbsp;file&nbsp;named&nbsp;"&lt;name&gt;.html".<br>
&nbsp;<br>
Module&nbsp;docs&nbsp;for&nbsp;core&nbsp;modules&nbsp;are&nbsp;assumed&nbsp;to&nbsp;be&nbsp;in<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;/usr/share/doc/pythonX.Y/html/library<br>
&nbsp;<br>
if&nbsp;the&nbsp;pythonX.Y-doc&nbsp;package&nbsp;is&nbsp;installed&nbsp;or&nbsp;in<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;https://docs.python.org/X.Y/library/<br>
&nbsp;<br>
This&nbsp;can&nbsp;be&nbsp;overridden&nbsp;by&nbsp;setting&nbsp;the&nbsp;PYTHONDOCS&nbsp;environment&nbsp;variable<br>
to&nbsp;a&nbsp;different&nbsp;URL&nbsp;or&nbsp;to&nbsp;a&nbsp;local&nbsp;directory&nbsp;containing&nbsp;the&nbsp;Library<br>
Reference&nbsp;Manual&nbsp;pages.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="builtins.html">builtins</a><br>
<a href="builtins.html">builtins</a><br>
<a href="importlib.html">importlib</a><br>
<a href="inspect.html">inspect</a><br>
</td><td width="25%" valign=top><a href="io.html">io</a><br>
<a href="os.html">os</a><br>
<a href="pkgutil.html">pkgutil</a><br>
<a href="platform.html">platform</a><br>
</td><td width="25%" valign=top><a href="re.html">re</a><br>
<a href="sys.html">sys</a><br>
<a href="time.html">time</a><br>
<a href="tokenize.html">tokenize</a><br>
</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
<a href="warnings.html">warnings</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>__all__</strong> = ['help']<br>
<strong>__annotations__</strong> = {}<br>
<strong>help</strong> = &lt;__main__.Helper instance&gt;</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Ka-Ping&nbsp;Yee&nbsp;&lt;ping@lfw.org&gt;</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Credits</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Guido&nbsp;van&nbsp;Rossum,&nbsp;for&nbsp;an&nbsp;excellent&nbsp;programming&nbsp;language.<br>
Tommy&nbsp;Burnette,&nbsp;the&nbsp;original&nbsp;creator&nbsp;of&nbsp;manpy.<br>
Paul&nbsp;Prescod,&nbsp;for&nbsp;all&nbsp;his&nbsp;work&nbsp;on&nbsp;onlinehelp.<br>
Richard&nbsp;Chamberlain,&nbsp;for&nbsp;the&nbsp;first&nbsp;implementation&nbsp;of&nbsp;textdoc.<br>
</td></tr></table>
</body></html>

45
docs/core.Context.html Normal file
View File

@ -0,0 +1,45 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class Context</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><strong>core.Context</strong> = <a name="core.Context">class Context</a>(<a href="core.mixins.ControlerMixin.html#ControlerMixin">core.mixins.ControlerMixin.ControlerMixin</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>The&nbsp;Context&nbsp;class&nbsp;consumes&nbsp;mixins&nbsp;to&nbsp;add&nbsp;functionality&nbsp;as&nbsp;needed.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="core.Context.html#Context">Context</a></dd>
<dd><a href="core.mixins.ControlerMixin.html#ControlerMixin">core.mixins.ControlerMixin.ControlerMixin</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Context-__init__"><strong>__init__</strong></a>(self, args)</dt><dd><tt>Construct&nbsp;a&nbsp;new&nbsp;'Context'&nbsp;object&nbsp;which&nbsp;pulls&nbsp;in&nbsp;mixins.<br>
:param&nbsp;args:&nbsp;The&nbsp;terminal&nbsp;passed&nbsp;arguments<br>
&nbsp;<br>
:return:&nbsp;returns&nbsp;nothing</tt></dd></dl>
<hr>
Methods inherited from <a href="core.mixins.ControlerMixin.html#ControlerMixin">core.mixins.ControlerMixin.ControlerMixin</a>:<br>
<dl><dt><a name="Context-createXPath"><strong>createXPath</strong></a>(self, data)</dt><dd><tt>Don't&nbsp;call&nbsp;directly&nbsp;from&nbsp;a&nbsp;command&nbsp;file.<br>
&nbsp;<br>
:return:&nbsp;created&nbsp;xpath&nbsp;string</tt></dd></dl>
<dl><dt><a name="Context-getImage"><strong>getImage</strong></a>(self)</dt><dd><tt>Get&nbsp;image&nbsp;of&nbsp;page&nbsp;we&nbsp;are&nbsp;on.<br>
&nbsp;<br>
:return:&nbsp;no&nbsp;return&nbsp;data</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="core.mixins.ControlerMixin.html#ControlerMixin">core.mixins.ControlerMixin.ControlerMixin</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>

24
docs/core.html Normal file
View File

@ -0,0 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package core</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>core</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/__init__.py">/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/__init__.py</a></font></td></tr></table>
<p><tt>Core&nbsp;module</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="core.Context.html">Context</a><br>
</td><td width="25%" valign=top><a href="core.mixins.html"><strong>mixins</strong>&nbsp;(package)</a><br>
</td><td width="25%" valign=top><a href="core.utils.html"><strong>utils</strong>&nbsp;(package)</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
</body></html>

View File

@ -0,0 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class ControlerMixin</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><strong>core.mixins.ControlerMixin</strong> = <a name="core.mixins.ControlerMixin">class ControlerMixin</a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>The&nbsp;ControlerMixin&nbsp;has&nbsp;methods&nbsp;to&nbsp;manage&nbsp;interaction&nbsp;with&nbsp;the&nbsp;browser.<br>
These&nbsp;get&nbsp;called&nbsp;from&nbsp;the&nbsp;_init__.Main&nbsp;class&nbsp;and&nbsp;ran.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="ControlerMixin-createXPath"><strong>createXPath</strong></a>(self, data)</dt><dd><tt>Don't&nbsp;call&nbsp;directly&nbsp;from&nbsp;a&nbsp;command&nbsp;file.<br>
&nbsp;<br>
:return:&nbsp;created&nbsp;xpath&nbsp;string</tt></dd></dl>
<dl><dt><a name="ControlerMixin-getImage"><strong>getImage</strong></a>(self)</dt><dd><tt>Get&nbsp;image&nbsp;of&nbsp;page&nbsp;we&nbsp;are&nbsp;on.<br>
&nbsp;<br>
:return:&nbsp;no&nbsp;return&nbsp;data</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>

22
docs/core.mixins.html Normal file
View File

@ -0,0 +1,22 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package core.mixins</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="core.html"><font color="#ffffff">core</font></a>.mixins</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/mixins/__init__.py">/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/mixins/__init__.py</a></font></td></tr></table>
<p><tt>Mixins&nbsp;module</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="core.mixins.ControlerMixin.html">ControlerMixin</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>
</body></html>

View File

@ -0,0 +1,32 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class Browser</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><strong>core.utils.Browser</strong> = <a name="core.utils.Browser">class Browser</a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>The&nbsp;Browser&nbsp;allows&nbsp;us&nbsp;to&nbsp;bring&nbsp;in&nbsp;selenium&nbsp;driver&nbsp;(a.k.a&nbsp;browser)&nbsp;related&nbsp;objects<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Browser-get_browser"><strong>get_browser</strong></a>(self, browserType=None, headless=None)</dt><dd><tt>Construct&nbsp;new&nbsp;selenium&nbsp;driver&nbsp;(a.k.a&nbsp;browser&nbsp;object)<br>
Sets&nbsp;the&nbsp;"self.<strong>driver</strong>"&nbsp;in&nbsp;Context&nbsp;object.<br>
:note:&nbsp;Should&nbsp;consider&nbsp;creating&nbsp;methods&nbsp;per&nbsp;browser&nbsp;type.<br>
:param&nbsp;browserType:&nbsp;The&nbsp;browser&nbsp;we&nbsp;want&nbsp;to&nbsp;use<br>
:param&nbsp;headless:&nbsp;If&nbsp;we&nbsp;have&nbsp;a&nbsp;gui&nbsp;or&nbsp;not<br>
&nbsp;<br>
:return:&nbsp;the&nbsp;selenium&nbsp;browser&nbsp;driver</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>

View File

@ -0,0 +1,39 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class Logger</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><strong>core.utils.Logger</strong> = <a name="core.utils.Logger">class Logger</a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Logger-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Initialize&nbsp;self.&nbsp;&nbsp;See&nbsp;help(type(self))&nbsp;for&nbsp;accurate&nbsp;signature.</tt></dd></dl>
<dl><dt><a name="Logger-get_logger"><strong>get_logger</strong></a>(self, loggerName='NO_LOGGER_NAME_PASSED', createFile=True)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;logging&nbsp;object&nbsp;and&nbsp;return&nbsp;it.<br>
:note:<br>
&nbsp;&nbsp;&nbsp;&nbsp;NOSET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;Don't&nbsp;know&nbsp;the&nbsp;actual&nbsp;log&nbsp;level&nbsp;of&nbsp;this...&nbsp;(defaulting&nbsp;or&nbsp;literally&nbsp;none?)<br>
&nbsp;&nbsp;&nbsp;&nbsp;Log&nbsp;Levels&nbsp;(From&nbsp;least&nbsp;to&nbsp;most)<br>
&nbsp;&nbsp;&nbsp;&nbsp;Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value<br>
&nbsp;&nbsp;&nbsp;&nbsp;CRITICAL&nbsp;&nbsp;&nbsp;50<br>
&nbsp;&nbsp;&nbsp;&nbsp;ERROR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;40<br>
&nbsp;&nbsp;&nbsp;&nbsp;WARNING&nbsp;&nbsp;&nbsp;&nbsp;30<br>
&nbsp;&nbsp;&nbsp;&nbsp;INFO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;20<br>
&nbsp;&nbsp;&nbsp;&nbsp;DEBUG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;10<br>
:param&nbsp;loggerName:&nbsp;Sets&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;logger&nbsp;object.&nbsp;(Used&nbsp;in&nbsp;log&nbsp;lines)<br>
:param&nbsp;createFile:&nbsp;Whether&nbsp;we&nbsp;create&nbsp;a&nbsp;log&nbsp;file&nbsp;or&nbsp;just&nbsp;pump&nbsp;to&nbsp;terminal<br>
&nbsp;<br>
:return:&nbsp;the&nbsp;logging&nbsp;object&nbsp;we&nbsp;created</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>

23
docs/core.utils.html Normal file
View File

@ -0,0 +1,23 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package core.utils</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="core.html"><font color="#ffffff">core</font></a>.utils</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/utils/__init__.py">/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/utils/__init__.py</a></font></td></tr></table>
<p><tt>Utils&nbsp;module</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="core.utils.Browser.html">Browser</a><br>
</td><td width="25%" valign=top><a href="core.utils.Logger.html">Logger</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>
</body></html>