Updated docs

missionpinball · Aug 6, 2015 · 359525e · 359525e
1 parent 98a0dc3
commit 359525e
Show file tree

Hide file tree

Showing 134 changed files with 455 additions and 2,266 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -48,7 +48,7 @@
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'mpf'
+master_doc = 'index'
 
 # General information about the project.
 project = u'Mission Pinball Framework'

diff --git a/docs/generated/doctrees/environment.pickle b/docs/generated/doctrees/environment.pickle
diff --git a/docs/generated/doctrees/index.doctree b/docs/generated/doctrees/index.doctree
diff --git a/docs/generated/doctrees/mc.doctree b/docs/generated/doctrees/mc.doctree
diff --git a/docs/generated/doctrees/mpf.devices.ball_device.doctree b/docs/generated/doctrees/mpf.devices.ball_device.doctree
diff --git a/docs/generated/doctrees/mpf.devices.driver.doctree b/docs/generated/doctrees/mpf.devices.driver.doctree
diff --git a/docs/generated/doctrees/mpf.devices.flipper.doctree b/docs/generated/doctrees/mpf.devices.flipper.doctree
diff --git a/docs/generated/doctrees/mpf.devices.score_reel.doctree b/docs/generated/doctrees/mpf.devices.score_reel.doctree
diff --git a/docs/generated/doctrees/mpf.devices.target.doctree b/docs/generated/doctrees/mpf.devices.target.doctree
diff --git a/docs/generated/doctrees/mpf.game.game.doctree b/docs/generated/doctrees/mpf.game.game.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.core.display.doctree b/docs/generated/doctrees/mpf.media_controller.core.display.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.core.doctree b/docs/generated/doctrees/mpf.media_controller.core.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.core.language.doctree b/docs/generated/doctrees/mpf.media_controller.core.language.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.core.modes.doctree b/docs/generated/doctrees/mpf.media_controller.core.modes.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.core.slide.doctree b/docs/generated/doctrees/mpf.media_controller.core.slide.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.core.sound.doctree b/docs/generated/doctrees/mpf.media_controller.core.sound.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.elements.doctree b/docs/generated/doctrees/mpf.media_controller.elements.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.elements.movie.doctree b/docs/generated/doctrees/mpf.media_controller.elements.movie.doctree
diff --git a/docs/generated/doctrees/mpf.media_controller.transitions.move_out.doctree b/docs/generated/doctrees/mpf.media_controller.transitions.move_out.doctree
diff --git a/docs/generated/doctrees/mpf.platform.doctree b/docs/generated/doctrees/mpf.platform.doctree
diff --git a/docs/generated/doctrees/mpf.platform.fadecandy.doctree b/docs/generated/doctrees/mpf.platform.fadecandy.doctree
diff --git a/docs/generated/doctrees/mpf.platform.fast.doctree b/docs/generated/doctrees/mpf.platform.fast.doctree
diff --git a/docs/generated/doctrees/mpf.platform.openpixel.doctree b/docs/generated/doctrees/mpf.platform.openpixel.doctree
diff --git a/docs/generated/doctrees/mpf.platform.p3_roc.doctree b/docs/generated/doctrees/mpf.platform.p3_roc.doctree
diff --git a/docs/generated/doctrees/mpf.platform.p_roc.doctree b/docs/generated/doctrees/mpf.platform.p_roc.doctree
diff --git a/docs/generated/doctrees/mpf.plugins.auditor.doctree b/docs/generated/doctrees/mpf.plugins.auditor.doctree
diff --git a/docs/generated/doctrees/mpf.plugins.doctree b/docs/generated/doctrees/mpf.plugins.doctree
diff --git a/docs/generated/doctrees/mpf.system.assets.doctree b/docs/generated/doctrees/mpf.system.assets.doctree
diff --git a/docs/generated/doctrees/mpf.system.bcp.doctree b/docs/generated/doctrees/mpf.system.bcp.doctree
diff --git a/docs/generated/doctrees/mpf.system.config.doctree b/docs/generated/doctrees/mpf.system.config.doctree
diff --git a/docs/generated/doctrees/mpf.system.events.doctree b/docs/generated/doctrees/mpf.system.events.doctree
diff --git a/docs/generated/doctrees/mpf.system.light_controller.doctree b/docs/generated/doctrees/mpf.system.light_controller.doctree
diff --git a/docs/generated/doctrees/mpf.system.modes.doctree b/docs/generated/doctrees/mpf.system.modes.doctree
diff --git a/docs/generated/doctrees/mpf.system.switch_controller.doctree b/docs/generated/doctrees/mpf.system.switch_controller.doctree
diff --git a/docs/generated/doctrees/mpf.system.target_controller.doctree b/docs/generated/doctrees/mpf.system.target_controller.doctree
diff --git a/docs/generated/doctrees/mpf.system.tasks.doctree b/docs/generated/doctrees/mpf.system.tasks.doctree
diff --git a/docs/generated/doctrees/mpf.system.timing.doctree b/docs/generated/doctrees/mpf.system.timing.doctree
diff --git a/docs/generated/html/_sources/index.txt b/docs/generated/html/_sources/index.txt
@@ -0,0 +1,26 @@
+.. Mission Pinball Framework documentation master file, created by
+   sphinx-quickstart on Wed Jun 25 00:36:07 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Mission Pinball Framework's module reference!
+=======================================================
+
+This is the module reference for the Mission Pinball Framework, a Python-based software framework for controlling real
+pinball machines via P-ROC or FAST Pinball hardware. The instructions and documentation are available at
+https://missionpinball.com/docs
+
+Contents:
+
+.. toctree::
+   :maxdepth: 3
+
+    mpf
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/generated/html/genindex.html b/docs/generated/html/genindex.html
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -4776,7 +4776,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/docs/generated/html/index.html b/docs/generated/html/index.html
@@ -0,0 +1,118 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <title>Welcome to Mission Pinball Framework’s module reference! &mdash; Mission Pinball Framework 0.19.0 documentation</title>
+
+    <link rel="stylesheet" href="_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.19.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="top" title="Mission Pinball Framework 0.19.0 documentation" href="#" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="#">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+
+  <div class="section" id="welcome-to-mission-pinball-framework-s-module-reference">
+<h1>Welcome to Mission Pinball Framework&#8217;s module reference!</h1>
+<p>This is the module reference for the Mission Pinball Framework, a Python-based software framework for controlling real
+pinball machines via P-ROC or FAST Pinball hardware. The instructions and documentation are available at
+<a class="reference external" href="https://missionpinball.com/docs">https://missionpinball.com/docs</a></p>
+<p>Contents:</p>
+<div class="toctree-wrapper compound">
+<ul class="simple">
+</ul>
+</div>
+</div>
+<div class="section" id="indices-and-tables">
+<h1>Indices and tables</h1>
+<ul class="simple">
+<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
+<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
+<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
+</ul>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="#">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Welcome to Mission Pinball Framework&#8217;s module reference!</a></li>
+<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+</ul>
+
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="_sources/index.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="#">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2015, Brian Madden, Gabe Knuth.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+    </div>
+  </body>
+</html>
diff --git a/docs/generated/html/mc.html b/docs/generated/html/mc.html
@@ -35,7 +35,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -85,7 +85,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/docs/generated/html/modules.html b/docs/generated/html/modules.html
@@ -35,7 +35,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -165,7 +165,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/docs/generated/html/mpf.devices.autofire.html b/docs/generated/html/mpf.devices.autofire.html
@@ -23,10 +23,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Mission Pinball Framework 0.19.0 documentation" href="index.html" />
-    <link rel="up" title="mpf.devices package" href="mpf.devices.html" />
-    <link rel="next" title="mpf.devices.ball_device module" href="mpf.devices.ball_device.html" />
-    <link rel="prev" title="mpf.devices package" href="mpf.devices.html" /> 
+    <link rel="top" title="Mission Pinball Framework 0.19.0 documentation" href="index.html" /> 
   </head>
   <body>
     <div class="related">
@@ -38,14 +35,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.ball_device.html" title="mpf.devices.ball_device module"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.html" title="mpf.devices package"
-             accesskey="P">previous</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li>
-          <li><a href="mpf.devices.html" accesskey="U">mpf.devices package</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -132,12 +122,6 @@ <h3>Navigation</h3>
       </div>
       <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="mpf.devices.html"
-                        title="previous chapter">mpf.devices package</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="mpf.devices.ball_device.html"
-                        title="next chapter">mpf.devices.ball_device module</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="_sources/mpf.devices.autofire.txt"
@@ -169,14 +153,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.ball_device.html" title="mpf.devices.ball_device module"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.html" title="mpf.devices package"
-             >previous</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li>
-          <li><a href="mpf.devices.html" >mpf.devices package</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/docs/generated/html/mpf.devices.ball_device.html b/docs/generated/html/mpf.devices.ball_device.html
@@ -23,10 +23,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Mission Pinball Framework 0.19.0 documentation" href="index.html" />
-    <link rel="up" title="mpf.devices package" href="mpf.devices.html" />
-    <link rel="next" title="mpf.devices.diverter module" href="mpf.devices.diverter.html" />
-    <link rel="prev" title="mpf.devices.autofire module" href="mpf.devices.autofire.html" /> 
+    <link rel="top" title="Mission Pinball Framework 0.19.0 documentation" href="index.html" /> 
   </head>
   <body>
     <div class="related">
@@ -38,14 +35,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.diverter.html" title="mpf.devices.diverter module"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.autofire.html" title="mpf.devices.autofire module"
-             accesskey="P">previous</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li>
-          <li><a href="mpf.devices.html" accesskey="U">mpf.devices package</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -338,12 +328,6 @@ <h3>Navigation</h3>
       </div>
       <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="mpf.devices.autofire.html"
-                        title="previous chapter">mpf.devices.autofire module</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="mpf.devices.diverter.html"
-                        title="next chapter">mpf.devices.diverter module</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="_sources/mpf.devices.ball_device.txt"
@@ -375,14 +359,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.diverter.html" title="mpf.devices.diverter module"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.autofire.html" title="mpf.devices.autofire module"
-             >previous</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li>
-          <li><a href="mpf.devices.html" >mpf.devices package</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

diff --git a/docs/generated/html/mpf.devices.diverter.html b/docs/generated/html/mpf.devices.diverter.html
@@ -23,10 +23,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Mission Pinball Framework 0.19.0 documentation" href="index.html" />
-    <link rel="up" title="mpf.devices package" href="mpf.devices.html" />
-    <link rel="next" title="mpf.devices.driver module" href="mpf.devices.driver.html" />
-    <link rel="prev" title="mpf.devices.ball_device module" href="mpf.devices.ball_device.html" /> 
+    <link rel="top" title="Mission Pinball Framework 0.19.0 documentation" href="index.html" /> 
   </head>
   <body>
     <div class="related">
@@ -38,14 +35,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.driver.html" title="mpf.devices.driver module"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.ball_device.html" title="mpf.devices.ball_device module"
-             accesskey="P">previous</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li>
-          <li><a href="mpf.devices.html" accesskey="U">mpf.devices package</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -201,12 +191,6 @@ <h3>Navigation</h3>
       </div>
       <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="mpf.devices.ball_device.html"
-                        title="previous chapter">mpf.devices.ball_device module</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="mpf.devices.driver.html"
-                        title="next chapter">mpf.devices.driver module</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="_sources/mpf.devices.diverter.txt"
@@ -238,14 +222,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.driver.html" title="mpf.devices.driver module"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="mpf.devices.ball_device.html" title="mpf.devices.ball_device module"
-             >previous</a> |</li>
-        <li><a href="mpf.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li>
-          <li><a href="mpf.devices.html" >mpf.devices package</a> &raquo;</li> 
+        <li><a href="index.html">Mission Pinball Framework 0.19.0 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">