Began adding Automation documentation

bjherger · May 26, 2018 · f043a71 · f043a71
1 parent 39fce32
commit f043a71
Show file tree

Hide file tree

Showing 17 changed files with 123 additions and 42 deletions.
diff --git a/docs/_build/doctrees/constants.doctree b/docs/_build/doctrees/constants.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/lib.doctree b/docs/_build/doctrees/lib.doctree
diff --git a/docs/_build/html/_sources/constants.rst.txt b/docs/_build/html/_sources/constants.rst.txt
@@ -1,5 +1,5 @@
 
-lib
+constants
 ========================================
 
 

diff --git a/docs/_build/html/_sources/lib.rst.txt b/docs/_build/html/_sources/lib.rst.txt
@@ -1,5 +1,5 @@
 
-constants
+lib
 ========================================
 
 

diff --git a/docs/_build/html/constants.html b/docs/_build/html/constants.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>lib &mdash; keras-pandas 1.0.0 documentation</title>
+  <title>constants &mdash; keras-pandas 1.0.0 documentation</title>
 
 
 
@@ -29,7 +29,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="constants" href="lib.html" /> 
+    <link rel="prev" title="lib" href="lib.html" /> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -84,9 +84,25 @@
 
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">keras-pandas</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="index.html#quick-start">Quick Start</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#usage">Usage</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html#contributing">Contributing</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="index.html#test">Test</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index.html#style-guide">Style guide</a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="index.html#generating-documentation">Generating documentation</a><ul class="current">
+<li class="toctree-l4"><a class="reference internal" href="automater.html">Automater</a></li>
+<li class="toctree-l4"><a class="reference internal" href="lib.html">lib</a></li>
+<li class="toctree-l4 current"><a class="current reference internal" href="#">constants</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="automater.html">Automater</a></li>
-<li class="toctree-l1"><a class="reference internal" href="lib.html">constants</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lib.html">lib</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">constants</a></li>
 </ul>
 
 
@@ -132,7 +148,7 @@
 
       <li><a href="index.html">Docs</a> &raquo;</li>
 
-      <li>lib</li>
+      <li>constants</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -152,7 +168,7 @@
            <div itemprop="articleBody">
 
   <div class="section" id="module-constants">
-<span id="lib"></span><h1>lib<a class="headerlink" href="#module-constants" title="Permalink to this headline">¶</a></h1>
+<span id="constants"></span><h1>constants<a class="headerlink" href="#module-constants" title="Permalink to this headline">¶</a></h1>
 <dl class="function">
 <dt id="constants.input_nub_categorical_handler">
 <code class="descclassname">constants.</code><code class="descname">input_nub_categorical_handler</code><span class="sig-paren">(</span><em>variable</em>, <em>input_dataframe</em><span class="sig-paren">)</span><a class="headerlink" href="#constants.input_nub_categorical_handler" title="Permalink to this definition">¶</a></dt>
@@ -174,7 +190,7 @@
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
 
-        <a href="lib.html" class="btn btn-neutral" title="constants" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="lib.html" class="btn btn-neutral" title="lib" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -86,8 +86,8 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="index.html">keras-pandas</a></li>
 <li class="toctree-l1"><a class="reference internal" href="automater.html">Automater</a></li>
-<li class="toctree-l1"><a class="reference internal" href="lib.html">constants</a></li>
-<li class="toctree-l1"><a class="reference internal" href="constants.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lib.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="constants.html">constants</a></li>
 </ul>
 
 

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -104,17 +104,17 @@
 <li class="toctree-l3"><a class="reference internal" href="#style-guide">Style guide</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#generating-documentation">Generating documentation</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="automater.html">Automater</a></li>
-<li class="toctree-l4"><a class="reference internal" href="lib.html">constants</a></li>
-<li class="toctree-l4"><a class="reference internal" href="constants.html">lib</a></li>
+<li class="toctree-l4"><a class="reference internal" href="lib.html">lib</a></li>
+<li class="toctree-l4"><a class="reference internal" href="constants.html">constants</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="automater.html">Automater</a></li>
-<li class="toctree-l1"><a class="reference internal" href="lib.html">constants</a></li>
-<li class="toctree-l1"><a class="reference internal" href="constants.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lib.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="constants.html">constants</a></li>
 </ul>
 
 
@@ -355,8 +355,8 @@ <h3>Generating documentation<a class="headerlink" href="#generating-documentatio
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="automater.html">Automater</a></li>
-<li class="toctree-l1"><a class="reference internal" href="lib.html">constants</a></li>
-<li class="toctree-l1"><a class="reference internal" href="constants.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lib.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="constants.html">constants</a></li>
 </ul>
 </div>
 </div>

diff --git a/docs/_build/html/lib.html b/docs/_build/html/lib.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>constants &mdash; keras-pandas 1.0.0 documentation</title>
+  <title>lib &mdash; keras-pandas 1.0.0 documentation</title>
 
 
 
@@ -29,7 +29,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="lib" href="constants.html" />
+    <link rel="next" title="constants" href="constants.html" />
     <link rel="prev" title="Automater" href="automater.html" /> 
 
 
@@ -85,9 +85,25 @@
 
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">keras-pandas</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="index.html#quick-start">Quick Start</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#usage">Usage</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html#contributing">Contributing</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="index.html#test">Test</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index.html#style-guide">Style guide</a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="index.html#generating-documentation">Generating documentation</a><ul class="current">
+<li class="toctree-l4"><a class="reference internal" href="automater.html">Automater</a></li>
+<li class="toctree-l4 current"><a class="current reference internal" href="#">lib</a></li>
+<li class="toctree-l4"><a class="reference internal" href="constants.html">constants</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="automater.html">Automater</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">constants</a></li>
-<li class="toctree-l1"><a class="reference internal" href="constants.html">lib</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="constants.html">constants</a></li>
 </ul>
 
 
@@ -133,7 +149,7 @@
 
       <li><a href="index.html">Docs</a> &raquo;</li>
 
-      <li>constants</li>
+      <li>lib</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -153,20 +169,27 @@
            <div itemprop="articleBody">
 
   <div class="section" id="module-lib">
-<span id="constants"></span><h1>constants<a class="headerlink" href="#module-lib" title="Permalink to this headline">¶</a></h1>
+<span id="lib"></span><h1>lib<a class="headerlink" href="#module-lib" title="Permalink to this headline">¶</a></h1>
 <dl class="function">
 <dt id="lib.check_variable_list_are_valid">
 <code class="descclassname">lib.</code><code class="descname">check_variable_list_are_valid</code><span class="sig-paren">(</span><em>variable_type_dict</em><span class="sig-paren">)</span><a class="headerlink" href="#lib.check_variable_list_are_valid" title="Permalink to this definition">¶</a></dt>
-<dd><table class="docutils field-list" frame="void" rules="none">
+<dd><p>Checks that the provided variable_type_dict is valid, by:</p>
+<blockquote>
+<div><ul class="simple">
+<li>Confirming there is no overlap between all variable lists</li>
+</ul>
+</div></blockquote>
+<table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>variable_type_dict</strong> – </td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>variable_type_dict</strong> – A dictionary, with keys describing variables types, and values listing particular</td>
 </tr>
 </tbody>
 </table>
+<p>variables
+:type variable_type_dict: {str:[str]}
+:return:</p>
 </dd></dl>
 
 <dl class="function">
@@ -201,7 +224,7 @@
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="constants.html" class="btn btn-neutral float-right" title="lib" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="constants.html" class="btn btn-neutral float-right" title="constants" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="automater.html" class="btn btn-neutral" title="Automater" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -92,8 +92,8 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="index.html">keras-pandas</a></li>
 <li class="toctree-l1"><a class="reference internal" href="automater.html">Automater</a></li>
-<li class="toctree-l1"><a class="reference internal" href="lib.html">constants</a></li>
-<li class="toctree-l1"><a class="reference internal" href="constants.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lib.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="constants.html">constants</a></li>
 </ul>
 
 

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -85,8 +85,8 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="index.html">keras-pandas</a></li>
 <li class="toctree-l1"><a class="reference internal" href="automater.html">Automater</a></li>
-<li class="toctree-l1"><a class="reference internal" href="lib.html">constants</a></li>
-<li class="toctree-l1"><a class="reference internal" href="constants.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lib.html">lib</a></li>
+<li class="toctree-l1"><a class="reference internal" href="constants.html">constants</a></li>
 </ul>