From ee241da4d0d35dbffa76613aaa230cb3ff099fc3 Mon Sep 17 00:00:00 2001 From: Maxim Stewart Date: Sat, 11 Apr 2020 15:39:42 -0500 Subject: [PATCH] Documentation generation --- docs/__main__.html | 99 ++++++++++++++++++++++++++++ docs/core.Context.html | 45 +++++++++++++ docs/core.html | 24 +++++++ docs/core.mixins.ControlerMixin.html | 33 ++++++++++ docs/core.mixins.html | 22 +++++++ docs/core.utils.Browser.html | 32 +++++++++ docs/core.utils.Logger.html | 39 +++++++++++ docs/core.utils.html | 23 +++++++ 8 files changed, 317 insertions(+) create mode 100644 docs/__main__.html create mode 100644 docs/core.Context.html create mode 100644 docs/core.html create mode 100644 docs/core.mixins.ControlerMixin.html create mode 100644 docs/core.mixins.html create mode 100644 docs/core.utils.Browser.html create mode 100644 docs/core.utils.Logger.html create mode 100644 docs/core.utils.html diff --git a/docs/__main__.html b/docs/__main__.html new file mode 100644 index 0000000..c237dca --- /dev/null +++ b/docs/__main__.html @@ -0,0 +1,99 @@ + +Python: module __main__ + + + + + +
 
+ 
__main__ (26 February 2001)		index
/usr/lib/python3.6/pydoc.py
Module Reference
+

Generate Python documentation in HTML or text for interactive use.
+ 
+At the Python interactive prompt, calling help(thing) on a Python object
+documents the object, and calling help() starts up an interactive
+help session.
+ 
+Or, at the shell command line outside of Python:
+ 
+Run "pydoc <name>" to show documentation on something.  <name> may be
+the name of a function, module, package, or a dotted reference to a
+class or function within a module or module in a package.  If the
+argument contains a path segment delimiter (e.g. slash on Unix,
+backslash on Windows) it is treated as the path to a Python source file.
+ 
+Run "pydoc -k <keyword>" to search for a keyword in the synopsis lines
+of all available modules.
+ 
+Run "pydoc -p <port>" to start an HTTP server on the given port on the
+local machine.  Port number 0 can be used to get an arbitrary unused port.
+ 
+Run "pydoc -b" to start an HTTP server on an arbitrary unused port and
+open a Web browser to interactively browse documentation.  The -p option
+can be used with the -b option to explicitly specify the server port.
+ 
+Run "pydoc -w <name>" to write out the HTML documentation for a module
+to a file named "<name>.html".
+ 
+Module docs for core modules are assumed to be in
+ 
+    /usr/share/doc/pythonX.Y/html/library
+ 
+if the pythonX.Y-doc package is installed or in
+ 
+    https://docs.python.org/X.Y/library/
+ 
+This can be overridden by setting the PYTHONDOCS environment variable
+to a different URL or to a local directory containing the Library
+Reference Manual pages.

+

+ + + + + +
 
+Modules
       
builtins
+builtins
+importlib
+inspect
+		io
+os
+pkgutil
+platform
+		re
+sys
+time
+tokenize
+		urllib
+warnings
+

+ + + + + +
 
+Data
       __all__ = ['help']
+__annotations__ = {}
+help = <__main__.Helper instance>

+ + + + + +
 
+Author
       Ka-Ping Yee <ping@lfw.org>

+ + + + + +
 
+Credits
       Guido van Rossum, for an excellent programming language.
+Tommy Burnette, the original creator of manpy.
+Paul Prescod, for all his work on onlinehelp.
+Richard Chamberlain, for the first implementation of textdoc.
+
+ \ No newline at end of file diff --git a/docs/core.Context.html b/docs/core.Context.html new file mode 100644 index 0000000..b638dd7 --- /dev/null +++ b/docs/core.Context.html @@ -0,0 +1,45 @@ + +Python: class Context + + +

+ + + + + + + +
 
+core.Context = class Context(core.mixins.ControlerMixin.ControlerMixin)
   The Context class consumes mixins to add functionality as needed.
 
 
Method resolution order:
+
Context
+
core.mixins.ControlerMixin.ControlerMixin
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, args)
Construct a new 'Context' object which pulls in mixins.
+:param args: The terminal passed arguments
+ 
+:return: returns nothing
+ +
+Methods inherited from core.mixins.ControlerMixin.ControlerMixin:
+
createXPath(self, data)
Don't call directly from a command file.
+ 
+:return: created xpath string
+ +
getImage(self)
Get image of page we are on.
+ 
+:return: no return data
+ +
+Data descriptors inherited from core.mixins.ControlerMixin.ControlerMixin:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/core.html b/docs/core.html new file mode 100644 index 0000000..cbc16a7 --- /dev/null +++ b/docs/core.html @@ -0,0 +1,24 @@ + +Python: package core + + + + + +
 
+ 
core		index
/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/__init__.py
+

Core module

+

+ + + + + +
 
+Package Contents
       
Context
+		mixins (package)
+		utils (package)
+
+ \ No newline at end of file diff --git a/docs/core.mixins.ControlerMixin.html b/docs/core.mixins.ControlerMixin.html new file mode 100644 index 0000000..ab24524 --- /dev/null +++ b/docs/core.mixins.ControlerMixin.html @@ -0,0 +1,33 @@ + +Python: class ControlerMixin + + +

+ + + + + + + +
 
+core.mixins.ControlerMixin = class ControlerMixin(builtins.object)
   The ControlerMixin has methods to manage interaction with the browser.
+These get called from the _init__.Main class and ran.
 
 Methods defined here:
+
createXPath(self, data)
Don't call directly from a command file.
+ 
+:return: created xpath string
+ +
getImage(self)
Get image of page we are on.
+ 
+:return: no return data
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/core.mixins.html b/docs/core.mixins.html new file mode 100644 index 0000000..59ece9f --- /dev/null +++ b/docs/core.mixins.html @@ -0,0 +1,22 @@ + +Python: package core.mixins + + + + + +
 
+ 
core.mixins		index
/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/mixins/__init__.py
+

Mixins module

+

+ + + + + +
 
+Package Contents
       
ControlerMixin
+
+ \ No newline at end of file diff --git a/docs/core.utils.Browser.html b/docs/core.utils.Browser.html new file mode 100644 index 0000000..3ee4881 --- /dev/null +++ b/docs/core.utils.Browser.html @@ -0,0 +1,32 @@ + +Python: class Browser + + +

+ + + + + + + +
 
+core.utils.Browser = class Browser(builtins.object)
   The Browser allows us to bring in selenium driver (a.k.a browser) related objects
 
 Methods defined here:
+
get_browser(self, browserType=None, headless=None)
Construct new selenium driver (a.k.a browser object)
+Sets the "self.driver" in Context object.
+:note: Should consider creating methods per browser type.
+:param browserType: The browser we want to use
+:param headless: If we have a gui or not
+ 
+:return: the selenium browser driver
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/core.utils.Logger.html b/docs/core.utils.Logger.html new file mode 100644 index 0000000..5942e3c --- /dev/null +++ b/docs/core.utils.Logger.html @@ -0,0 +1,39 @@ + +Python: class Logger + + +

+ + + + + +
 
+core.utils.Logger = class Logger(builtins.object)
    Methods defined here:
+
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
+ +
get_logger(self, loggerName='NO_LOGGER_NAME_PASSED', createFile=True)
Create a new logging object and return it.
+:note:
+    NOSET     # Don't know the actual log level of this... (defaulting or literally none?)
+    Log Levels (From least to most)
+    Type      Value
+    CRITICAL   50
+    ERROR      40
+    WARNING    30
+    INFO       20
+    DEBUG      10
+:param loggerName: Sets the name of the logger object. (Used in log lines)
+:param createFile: Whether we create a log file or just pump to terminal
+ 
+:return: the logging object we created
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/core.utils.html b/docs/core.utils.html new file mode 100644 index 0000000..a932450 --- /dev/null +++ b/docs/core.utils.html @@ -0,0 +1,23 @@ + +Python: package core.utils + + + + + +
 
+ 
core.utils		index
/home/abaddon/Coding/Projects/Python_Projects/000_Usable/selenium/Selenium-Automation-Template/src/core/utils/__init__.py
+

Utils module

+

+ + + + + +
 
+Package Contents
       
Browser
+		Logger
+
+ \ No newline at end of file