Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
Updated documentation for release 1.0.1
  • Loading branch information
mooshu1x2 committed Jul 29, 2016
1 parent 4fcc5c1 commit a90c42d3d09f025d6e4b700b844165d07299e689
Showing 10 changed files with 53 additions and 16 deletions.
@@ -96,7 +96,7 @@ To build UserAle's documentation, create a directory at the root level of ``/use

::

$ mkdir userale.pyqt5-docs & cd userale.pyqt5/docs
$ mkdir userale.pyqt5-docs & cd userale.pyqt5-docs

Execute build command:

@@ -54,3 +54,11 @@ Simply instantiate UserAle and install it as an event filter in your application
ale = Ale (output="mouse.log", user="testUser", version="0.0.1")
# install globally
app.installEventFilter (ale)


Instrumenting Your Application Manually with UserAle
----------------------------------------------------

.. todo::

Write guidelines for instrumenting specific PyQt5 Widgets with UserAle.
@@ -141,8 +141,7 @@

<div class="section" id="authors">
<h1>Authors<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h1>
<p>UserAle.pyqt5 is written and maintained by Michelle Beard and
various contributors:</p>
<p id="id1">UserAle.pyqt5 is written and maintained by Draper and various contributors:</p>
<div class="section" id="development-lead">
<h2>Development Lead<a class="headerlink" href="#development-lead" title="Permalink to this headline"></a></h2>
<ul class="simple">
@@ -155,7 +154,6 @@ <h2>Additional Staff<a class="headerlink" href="#additional-staff" title="Permal
<li>Laura Mariano &lt;<a class="reference external" href="mailto:lmariano&#37;&#52;&#48;draper&#46;com">lmariano<span>&#64;</span>draper<span>&#46;</span>com</a>&gt;</li>
<li>Dr. Joshua Poore &lt;<a class="reference external" href="mailto:jpoore&#37;&#52;&#48;draper&#46;com">jpoore<span>&#64;</span>draper<span>&#46;</span>com</a>&gt;</li>
<li>Clay Gimenez &lt;<a class="reference external" href="mailto:cgimenez&#37;&#52;&#48;draper&#46;com">cgimenez<span>&#64;</span>draper<span>&#46;</span>com</a>&gt;</li>
<li>Steven York &lt;<a class="reference external" href="mailto:syork&#37;&#52;&#48;draper&#46;com">syork<span>&#64;</span>draper<span>&#46;</span>com</a>&gt;</li>
<li>Hugh Enxing &lt;<a class="reference external" href="mailto:henxing&#37;&#52;&#48;draper&#46;com">henxing<span>&#64;</span>draper<span>&#46;</span>com</a>&gt;</li>
</ul>
</div>
@@ -92,7 +92,8 @@
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to UserAle.pyqt5</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">UserAle Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-1-0-0">Version 1.0.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="#changelog">1.0.1 (2016-07-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">1.0.0 (2016-06-24)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
@@ -141,13 +142,33 @@
<div class="section" id="userale-changelog">
<h1>UserAle Changelog<a class="headerlink" href="#userale-changelog" title="Permalink to this headline"></a></h1>
<p>Here you can see the full list of changes between each UserAle.pyqt5 release.</p>
<div class="section" id="version-1-0-0">
<h2>Version 1.0.0<a class="headerlink" href="#version-1-0-0" title="Permalink to this headline"></a></h2>
<div class="section" id="changelog">
<span id="id1"></span><h2>1.0.1 (2016-07-29)<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">All logs will be stored to file called userale.log (configurable).</p>
</li>
<li><p class="first">Users can specify which events to capture by passing in a list of event keys when instantiating UserAle.</p>
</li>
<li><p class="first">These are the events UserAle is tracking:</p>
<blockquote>
<div><ul class="simple">
<li>Initial commit.</li>
<li><code class="docutils literal"><span class="pre">mouseup</span></code></li>
<li><code class="docutils literal"><span class="pre">mousedown</span></code></li>
<li><code class="docutils literal"><span class="pre">mouseover</span></code></li>
<li><code class="docutils literal"><span class="pre">keypress</span></code> (optional)</li>
<li><code class="docutils literal"><span class="pre">keydown</span></code> (optional)</li>
<li><code class="docutils literal"><span class="pre">dragstart</span></code></li>
<li><code class="docutils literal"><span class="pre">dragleave</span></code></li>
<li><code class="docutils literal"><span class="pre">dragmove</span></code></li>
<li><code class="docutils literal"><span class="pre">dragdrop</span></code></li>
</ul>
</div></blockquote>
</li>
</ul>
</div>
<div class="section" id="id2">
<h2>1.0.0 (2016-06-24)<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<p>Initial release.</p>
</div>
</div>

@@ -136,16 +136,16 @@
<div itemprop="articleBody">

<div class="section" id="contributing-to-userale-pyqt5">
<h1>Contributing to UserAle.pyqt5<a class="headerlink" href="#contributing-to-userale-pyqt5" title="Permalink to this headline"></a></h1>
<span id="contributing"></span><h1>Contributing to UserAle.pyqt5<a class="headerlink" href="#contributing-to-userale-pyqt5" title="Permalink to this headline"></a></h1>
<p>Thank you for contributing to the UserAle project!</p>
<p>There are certain procedures that must be followed for all contributions. These
procedures are necessary to allow us to allocate resources for reviewing and
testing your contribution, as well as communicate effectively with you during
the review process.</p>
<ol class="arabic">
<li><p class="first">Create an issue in our JIRA</p>
<li><p class="first">Create an issue in GitHub</p>
<blockquote>
<div><p>All changes to UserAle must have corresponding issues in JIRA so the
<div><p>All changes to UserAle must have corresponding issues in GitHub so the
change can be properly tracked:</p>
<blockquote>
<div><p><a class="reference external" href="https://github.com/draperlaboratory/userale.pyqt5/issues">https://github.com/draperlaboratory/userale.pyqt5/issues</a></p>
@@ -138,8 +138,8 @@
<h1>UserAle<a class="headerlink" href="#userale" title="Permalink to this headline"></a></h1>
<p>UserAle.pyqt5 is one of the Software As A Sensor™ products. The goal of Software As A Sensor™ is to develop understanding
of your users through their interactions with your software product. You can then apply that understanding to improve your
product&#8217;s design and funtionality. UserAle.pyqt5 provides an easy way to generate highly detailed log streams from an PyQT5 application.</p>
<p>UserAle.pyqt5 is developed at Draper and released free and open source through the Apache v2.0 license. Bug reports and contributions are welcome through Github.</p>
product&#8217;s design and functionality. UserAle.pyqt5 provides an easy way to generate highly detailed log streams from any PyQt5 application.</p>
<p>UserAle.pyqt5 is developed at Draper and released free and open source through the Apache v2.0 license. Bug reports and contributions are welcome through GitHub.</p>
<div class="section" id="user-s-guide">
<h2>User&#8217;s Guide<a class="headerlink" href="#user-s-guide" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
@@ -153,6 +153,7 @@ <h2>User&#8217;s Guide<a class="headerlink" href="#user-s-guide" title="Permalin
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#instrumenting-your-application-globally-with-userale">Instrumenting Your Application Globally with UserAle</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#instrumenting-your-application-manually-with-userale">Instrumenting Your Application Manually with UserAle</a></li>
</ul>
</li>
</ul>
@@ -182,7 +183,8 @@ <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permal
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to UserAle.pyqt5</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">UserAle Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-0-0">Version 1.0.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#changelog">1.0.1 (2016-07-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">1.0.0 (2016-06-24)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
@@ -209,7 +209,7 @@ <h2>Installing Documentation<a class="headerlink" href="#installing-documentatio
<p>To save yourself the trouble, all up to date documentation is available at <a class="reference external" href="https://draperlaboratory.github.io/userale.pyqt5/">https://draperlaboratory.github.io/userale.pyqt5/</a>.</p>
<p>However, if you want to manully build the documentation, the instructions are below.</p>
<p>To build UserAle&#8217;s documentation, create a directory at the root level of <code class="docutils literal"><span class="pre">/userale.pyqt5</span></code> called userale.pyqt5-docs.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ mkdir userale.pyqt5-docs &amp; cd userale.pyqt5/docs
<div class="highlight-default"><div class="highlight"><pre><span></span>$ mkdir userale.pyqt5-docs &amp; cd userale.pyqt5-docs
</pre></div>
</div>
<p>Execute build command:</p>
BIN +45 Bytes (110%) objects.inv
Binary file not shown.
@@ -85,6 +85,7 @@
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#instrumenting-your-application-globally-with-userale">Instrumenting Your Application Globally with UserAle</a></li>
<li class="toctree-l2"><a class="reference internal" href="#instrumenting-your-application-manually-with-userale">Instrumenting Your Application Manually with UserAle</a></li>
</ul>
</li>
</ul>
@@ -187,6 +188,13 @@ <h2>Instrumenting Your Application Globally with UserAle<a class="headerlink" hr
</pre></div>
</div>
</div>
<div class="section" id="instrumenting-your-application-manually-with-userale">
<h2>Instrumenting Your Application Manually with UserAle<a class="headerlink" href="#instrumenting-your-application-manually-with-userale" title="Permalink to this headline"></a></h2>
<div class="admonition-todo admonition" id="index-0">
<p class="first admonition-title">Todo</p>
<p class="last">Write guidelines for instrumenting specific PyQt5 Widgets with UserAle.</p>
</div>
</div>
</div>


Some generated files are not rendered by default. Learn more.

0 comments on commit a90c42d

Please sign in to comment.