Documentation generation
This commit is contained in:
parent
843d73ff43
commit
ee241da4d0
|
|
@ -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> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <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 Python documentation in HTML or text for interactive use.<br>
|
||||
<br>
|
||||
At the Python interactive prompt, calling help(thing) on a Python object<br>
|
||||
documents the object, and calling help() starts up an interactive<br>
|
||||
help session.<br>
|
||||
<br>
|
||||
Or, at the shell command line outside of Python:<br>
|
||||
<br>
|
||||
Run "pydoc <name>" to show documentation on something. <name> may be<br>
|
||||
the name of a function, module, package, or a dotted reference to a<br>
|
||||
class or function within a module or module in a package. If the<br>
|
||||
argument contains a path segment delimiter (e.g. slash on Unix,<br>
|
||||
backslash on Windows) it is treated as the path to a Python source file.<br>
|
||||
<br>
|
||||
Run "pydoc -k <keyword>" to search for a keyword in the synopsis lines<br>
|
||||
of all available modules.<br>
|
||||
<br>
|
||||
Run "pydoc -p <port>" to start an HTTP server on the given port on the<br>
|
||||
local machine. Port number 0 can be used to get an arbitrary unused port.<br>
|
||||
<br>
|
||||
Run "pydoc -b" to start an HTTP server on an arbitrary unused port and<br>
|
||||
open a Web browser to interactively browse documentation. The -p option<br>
|
||||
can be used with the -b option to explicitly specify the server port.<br>
|
||||
<br>
|
||||
Run "pydoc -w <name>" to write out the HTML documentation for a module<br>
|
||||
to a file named "<name>.html".<br>
|
||||
<br>
|
||||
Module docs for core modules are assumed to be in<br>
|
||||
<br>
|
||||
/usr/share/doc/pythonX.Y/html/library<br>
|
||||
<br>
|
||||
if the pythonX.Y-doc package is installed or in<br>
|
||||
<br>
|
||||
https://docs.python.org/X.Y/library/<br>
|
||||
<br>
|
||||
This can be overridden by setting the PYTHONDOCS environment variable<br>
|
||||
to a different URL or to a local directory containing the Library<br>
|
||||
Reference Manual pages.</tt></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#aa55cc">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </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> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><strong>__all__</strong> = ['help']<br>
|
||||
<strong>__annotations__</strong> = {}<br>
|
||||
<strong>help</strong> = <__main__.Helper instance></td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#7799ee">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
|
||||
<td width="100%">Ka-Ping Yee <ping@lfw.org></td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#7799ee">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Credits</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
|
||||
<td width="100%">Guido van Rossum, for an excellent programming language.<br>
|
||||
Tommy Burnette, the original creator of manpy.<br>
|
||||
Paul Prescod, for all his work on onlinehelp.<br>
|
||||
Richard Chamberlain, for the first implementation of textdoc.<br>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
|
|
@ -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> <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> </tt></td>
|
||||
<td colspan=2><tt>The Context class consumes mixins to add functionality as needed.<br> </tt></td></tr>
|
||||
<tr><td> </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 a new 'Context' object which pulls in mixins.<br>
|
||||
:param args: The terminal passed arguments<br>
|
||||
<br>
|
||||
:return: returns 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 call directly from a command file.<br>
|
||||
<br>
|
||||
:return: created xpath string</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Context-getImage"><strong>getImage</strong></a>(self)</dt><dd><tt>Get image of page we are on.<br>
|
||||
<br>
|
||||
:return: no return 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 for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
|
|
@ -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> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <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 module</tt></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#aa55cc">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </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> (package)</a><br>
|
||||
</td><td width="25%" valign=top><a href="core.utils.html"><strong>utils</strong> (package)</a><br>
|
||||
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
</body></html>
|
||||
|
|
@ -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> <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> </tt></td>
|
||||
<td colspan=2><tt>The ControlerMixin has methods to manage interaction with the browser.<br>
|
||||
These get called from the _init__.Main class and ran.<br> </tt></td></tr>
|
||||
<tr><td> </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 call directly from a command file.<br>
|
||||
<br>
|
||||
:return: created xpath string</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="ControlerMixin-getImage"><strong>getImage</strong></a>(self)</dt><dd><tt>Get image of page we are on.<br>
|
||||
<br>
|
||||
:return: no return data</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
|
|
@ -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> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <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 module</tt></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#aa55cc">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </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>
|
||||
|
|
@ -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> <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> </tt></td>
|
||||
<td colspan=2><tt>The Browser allows us to bring in selenium driver (a.k.a browser) related objects<br> </tt></td></tr>
|
||||
<tr><td> </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 new selenium driver (a.k.a browser object)<br>
|
||||
Sets the "self.<strong>driver</strong>" in Context object.<br>
|
||||
:note: Should consider creating methods per browser type.<br>
|
||||
:param browserType: The browser we want to use<br>
|
||||
:param headless: If we have a gui or not<br>
|
||||
<br>
|
||||
:return: the selenium browser driver</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
|
|
@ -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> <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> </tt></td><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Logger-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Initialize self. See help(type(self)) for accurate 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 a new logging object and return it.<br>
|
||||
:note:<br>
|
||||
NOSET # Don't know the actual log level of this... (defaulting or literally none?)<br>
|
||||
Log Levels (From least to most)<br>
|
||||
Type Value<br>
|
||||
CRITICAL 50<br>
|
||||
ERROR 40<br>
|
||||
WARNING 30<br>
|
||||
INFO 20<br>
|
||||
DEBUG 10<br>
|
||||
:param loggerName: Sets the name of the logger object. (Used in log lines)<br>
|
||||
:param createFile: Whether we create a log file or just pump to terminal<br>
|
||||
<br>
|
||||
:return: the logging object we created</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
|
|
@ -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> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <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 module</tt></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#aa55cc">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </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>
|
||||
Loading…
Reference in New Issue