documentation: classes will be displayed in documentation as 'transfo… (

#206)

* documentation: classes will be displayed in documentation as 'transformations'

* minor fix

docs/api.rst

@@ -18,13 +18,10 @@ Sources:
 Transformations:
 ****************
 
-.. automodule:: storey.flow
-    :members:
-    :show-inheritance:
-
-.. automodule:: storey.dataframe
+.. automodule:: storey.transformations
     :members:
     :show-inheritance:
+    :imported-members:
 
 
 Miscellaneous:

docs/build/_sources/api.rst.txt

@@ -18,13 +18,10 @@ Sources:
 Transformations:
 ****************
 
-.. automodule:: storey.flow
-    :members:
-    :show-inheritance:
-
-.. automodule:: storey.dataframe
+.. automodule:: storey.transformations
     :members:
     :show-inheritance:
+    :imported-members:
 
 
 Miscellaneous:

docs/build/genindex.html

@@ -113,7 +113,7 @@ <h1 class="site-logo" id="site-title">storey  documentation</h1>
             </button>
 
 
-            <!-- SyncEmitSource interaction buttons -->
+            <!-- Source interaction buttons -->
 
 
             <!-- Full screen (wrap in <a> to have style consistency -->
@@ -147,7 +147,6 @@ <h1 id="index">Index</h1>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
- | <a href="#H"><strong>H</strong></a>
  | <a href="#J"><strong>J</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
@@ -165,20 +164,22 @@ <h2 id="A">A</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#storey.aggregations.AggregateByKey">AggregateByKey (class in storey.aggregations)</a>
 </li>
-      <li><a href="api.html#storey.sources.AsyncAwaitableResult">AsyncAwaitableResult (class in storey.sources)</a>
+      <li><a href="api.html#storey.transformations.Assert">Assert (class in storey.transformations)</a>
 </li>
-      <li><a href="api.html#storey.sources.AsyncFlowController">AsyncFlowController (class in storey.sources)</a>
+      <li><a href="api.html#storey.sources.AsyncAwaitableResult">AsyncAwaitableResult (class in storey.sources)</a>
 </li>
       <li><a href="api.html#storey.sources.AsyncEmitSource">AsyncEmitSource (class in storey.sources)</a>
 </li>
+      <li><a href="api.html#storey.sources.AsyncFlowController">AsyncFlowController (class in storey.sources)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#storey.sources.AsyncAwaitableResult.await_result">await_result() (storey.sources.AsyncAwaitableResult method)</a>
 
       <ul>
         <li><a href="api.html#storey.sources.AwaitableResult.await_result">(storey.sources.AwaitableResult method)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#storey.sources.AsyncFlowController.await_termination">await_termination() (storey.sources.AsyncFlowController method)</a>
 
       <ul>
@@ -195,28 +196,20 @@ <h2 id="A">A</h2>
 <h2 id="B">B</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.Batch">Batch (class in storey.flow)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.build_flow">build_flow() (in module storey.flow)</a>
+      <li><a href="api.html#storey.transformations.Batch">Batch (class in storey.transformations)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.Choice">Choice (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.Choice">Choice (class in storey.transformations)</a>
 </li>
       <li><a href="api.html#storey.drivers.V3ioDriver.close">close() (storey.drivers.V3ioDriver method)</a>
-</li>
-      <li><a href="api.html#storey.flow.Complete">Complete (class in storey.flow)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.Context">Context (class in storey.flow)</a>
-</li>
       <li><a href="api.html#storey.sources.CSVSource">CSVSource (class in storey.sources)</a>
 </li>
       <li><a href="api.html#storey.targets.CSVTarget">CSVTarget (class in storey.targets)</a>
@@ -267,45 +260,33 @@ <h2 id="F">F</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#storey.dtypes.FieldAggregator">FieldAggregator (class in storey.dtypes)</a>
 </li>
-      <li><a href="api.html#storey.flow.Filter">Filter (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.Filter">Filter (class in storey.transformations)</a>
 </li>
       <li><a href="api.html#storey.dtypes.FixedWindow">FixedWindow (class in storey.dtypes)</a>
 </li>
       <li><a href="api.html#storey.dtypes.FixedWindows">FixedWindows (class in storey.dtypes)</a>
+</li>
+      <li><a href="api.html#storey.transformations.FlatMap">FlatMap (class in storey.transformations)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.FlatMap">FlatMap (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.Flatten">Flatten (class in storey.transformations)</a>
 </li>
       <li><a href="api.html#storey.sources.FlowAwaiter">FlowAwaiter (class in storey.sources)</a>
 </li>
       <li><a href="api.html#storey.sources.FlowController">FlowController (class in storey.sources)</a>
 </li>
       <li><a href="api.html#storey.dtypes.FlowError">FlowError</a>
 </li>
-  </ul></td>
-</tr></table>
-
-<h2 id="H">H</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.HttpRequest">HttpRequest (class in storey.flow)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.HttpResponse">HttpResponse (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.ForEach">ForEach (class in storey.transformations)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="J">J</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.JoinWithTable">JoinWithTable (class in storey.flow)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.JoinWithV3IOTable">JoinWithV3IOTable (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.JoinWithTable">JoinWithTable (class in storey.transformations)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -321,13 +302,13 @@ <h2 id="L">L</h2>
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.Map">Map (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.Map">Map (class in storey.transformations)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.MapClass">MapClass (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.MapClass">MapClass (class in storey.transformations)</a>
 </li>
-      <li><a href="api.html#storey.flow.MapWithState">MapWithState (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.MapWithState">MapWithState (class in storey.transformations)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -354,6 +335,8 @@ <h2 id="P">P</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#storey.targets.ParquetTarget">ParquetTarget (class in storey.targets)</a>
+</li>
+      <li><a href="api.html#storey.transformations.Partition">Partition (class in storey.transformations)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -368,12 +351,6 @@ <h2 id="Q">Q</h2>
 
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.Reduce">Reduce (class in storey.flow)</a>
-</li>
-      <li><a href="api.html#storey.dataframe.ReduceToDataFrame">ReduceToDataFrame (class in storey.dataframe)</a>
-</li>
-  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#storey.sources.AsyncEmitSource.run">run() (storey.sources.AsyncEmitSource method)</a>
 
@@ -387,33 +364,33 @@ <h2 id="R">R</h2>
 <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.flow.SendToHttp">SendToHttp (class in storey.flow)</a>
+      <li><a href="api.html#storey.transformations.SampleWindow">SampleWindow (class in storey.transformations)</a>
+</li>
+      <li><a href="api.html#storey.transformations.SendToHttp">SendToHttp (class in storey.transformations)</a>
 </li>
       <li><a href="api.html#storey.dtypes.SlidingWindow">SlidingWindow (class in storey.dtypes)</a>
 </li>
       <li><a href="api.html#storey.dtypes.SlidingWindows">SlidingWindows (class in storey.dtypes)</a>
-</li>
-      <li><a href="api.html#storey.sources.SyncEmitSource">SyncEmitSource (class in storey.sources)</a>
 </li>
       <li><a href="api.html#module-storey.aggregations">storey.aggregations (module)</a>
 </li>
-      <li><a href="api.html#module-storey.dataframe">storey.dataframe (module)</a>
+      <li><a href="api.html#module-storey.drivers">storey.drivers (module)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#module-storey.drivers">storey.drivers (module)</a>
-</li>
       <li><a href="api.html#module-storey.dtypes">storey.dtypes (module)</a>
-</li>
-      <li><a href="api.html#module-storey.flow">storey.flow (module)</a>
 </li>
       <li><a href="api.html#module-storey.sources">storey.sources (module)</a>
 </li>
       <li><a href="api.html#module-storey.table">storey.table (module)</a>
 </li>
       <li><a href="api.html#module-storey.targets">storey.targets (module)</a>
+</li>
+      <li><a href="api.html#module-storey.transformations">storey.transformations (module)</a>
 </li>
       <li><a href="api.html#storey.targets.StreamTarget">StreamTarget (class in storey.targets)</a>
+</li>
+      <li><a href="api.html#storey.sources.SyncEmitSource">SyncEmitSource (class in storey.sources)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -431,9 +408,7 @@ <h2 id="T">T</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#storey.dataframe.ReduceToDataFrame.to">to() (storey.dataframe.ReduceToDataFrame method)</a>
-</li>
-      <li><a href="api.html#storey.dataframe.ToDataFrame">ToDataFrame (class in storey.dataframe)</a>
+      <li><a href="api.html#storey.transformations.ToDataFrame">ToDataFrame (class in storey.transformations)</a>
 </li>
       <li><a href="api.html#storey.targets.TSDBTarget">TSDBTarget (class in storey.targets)</a>
 </li>

docs/build/index.html

@@ -130,7 +130,7 @@ <h1 class="site-logo" id="site-title">storey  documentation</h1>
     </div>
 </div>
 
-            <!-- SyncEmitSource interaction buttons -->
+            <!-- Source interaction buttons -->
 
 
             <!-- Full screen (wrap in <a> to have style consistency -->
@@ -247,7 +247,7 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
 <li class="toctree-l1"><a class="reference internal" href="api.html">Storey api</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="api.html#module-storey.targets">Targets:</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#module-storey.sources">Sources:</a></li>
-<li class="toctree-l2"><a class="reference internal" href="api.html#module-storey.flow">Transformations:</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api.html#module-storey.transformations">Transformations:</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#module-storey.drivers">Miscellaneous:</a></li>
 </ul>
 </li>

docs/build/py-modindex.html

@@ -115,7 +115,7 @@ <h1 class="site-logo" id="site-title">storey  documentation</h1>
             </button>
 
 
-            <!-- SyncEmitSource interaction buttons -->
+            <!-- Source interaction buttons -->
 
 
             <!-- Full screen (wrap in <a> to have style consistency -->
@@ -161,11 +161,6 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="api.html#module-storey.aggregations"><code class="xref">storey.aggregations</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-1">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="api.html#module-storey.dataframe"><code class="xref">storey.dataframe</code></a></td><td>
-       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
@@ -179,22 +174,22 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="api.html#module-storey.flow"><code class="xref">storey.flow</code></a></td><td>
+       <a href="api.html#module-storey.sources"><code class="xref">storey.sources</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="api.html#module-storey.sources"><code class="xref">storey.sources</code></a></td><td>
+       <a href="api.html#module-storey.table"><code class="xref">storey.table</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="api.html#module-storey.table"><code class="xref">storey.table</code></a></td><td>
+       <a href="api.html#module-storey.targets"><code class="xref">storey.targets</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="api.html#module-storey.targets"><code class="xref">storey.targets</code></a></td><td>
+       <a href="api.html#module-storey.transformations"><code class="xref">storey.transformations</code></a></td><td>
        <em></em></td></tr>
    </table>
 

docs/build/search.html

@@ -117,7 +117,7 @@ <h1 class="site-logo" id="site-title">storey  documentation</h1>
             </button>
 
 
-            <!-- SyncEmitSource interaction buttons -->
+            <!-- Source interaction buttons -->
 
 
             <!-- Full screen (wrap in <a> to have style consistency -->