Fixing documentation.
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
index cfca93c..495ad79 100644
--- a/docs/source/quickstart.rst
+++ b/docs/source/quickstart.rst
@@ -39,7 +39,7 @@
app = QApplication(sys.argv)
ex = TestApplication()
# Initiate UserAle
- ale = Ale ()
+ ale = Ale (output="mouse.log", user="testUser", version="0.0.1")
# install globally
app.installEventFilter (ale)
@@ -51,6 +51,6 @@
::
# Initiate UserAle
- ale = Ale ()
+ ale = Ale (output="mouse.log", user="testUser", version="0.0.1")
# install globally
- app.installEventFilter (ale)
\ No newline at end of file
+ app.installEventFilter (ale)
diff --git a/docs/source/userale.api.rst b/docs/source/userale.api.rst
deleted file mode 100644
index 8ebcfe3..0000000
--- a/docs/source/userale.api.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-UserALE API
------------
-
-.. automodule:: userale.ale
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/userale.logger.rst b/docs/source/userale.logger.rst
deleted file mode 100644
index b872be4..0000000
--- a/docs/source/userale.logger.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-UserALE Logger
---------------
-
-.. automodule:: userale.logger
- :members:
- :undoc-members:
- :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/userale.rst b/docs/source/userale.rst
index 7b8ec24..ade0cab 100644
--- a/docs/source/userale.rst
+++ b/docs/source/userale.rst
@@ -1,13 +1,15 @@
-API
----
+.. _api:
-.. toctree::
- userale.api
+ALE Library
+===========
+UserALE intercepts all application events by letting the developer install an event filter in their PyQT5 application to generate detailed user logs. UserAle does not capture system level logs or events generated by a non-user (a.k.a. system and signals sent between QObjects).
-Logger
-------
+UserAle
+-------
-.. toctree::
-
- userale.logger
\ No newline at end of file
+.. automodule:: userale.ale
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/userale/ale.py b/userale/ale.py
index a57fdfb..5d9621c 100644
--- a/userale/ale.py
+++ b/userale/ale.py
@@ -22,11 +22,7 @@
_ = StructuredMessage
class Ale (QObject):
- """
- UserALE intercepts all application events by letting the developer install an event filter in their PyQT5 application to
- generate detailed user logs. UserAle does not capture system level logs or events generated by a non-user
- (a.k.a. system and signals sent between QObjects).
- """
+
def __init__(self,
output="userale.log",
autostart=True,
@@ -51,13 +47,13 @@
.. code-block:: python
{
- 'target': ,
+ 'target': 'testLineEdit',
'path': ['Example', 'testLineEdit'],
'clientTime': ,
'location': {'x': 82, 'y': 0},
- 'type': 'dragstart',
+ 'type': 'mouseHover',
'userAction': 'true',
- 'details' : [ ],
+ 'details' : [],
'userId': 'userABC1234',
'toolVersion': 'myApplication',
'useraleVersion': '1.0.0 alpha'
diff --git a/userale/format.py b/userale/format.py
index 80d54c3..aeeb6ba 100644
--- a/userale/format.py
+++ b/userale/format.py
@@ -1,6 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
# Copyright 2016 The Charles Stark Draper Laboratory, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
