fix wrong confg in mkdocs.yml

.gitignore

@@ -1 +1,4 @@
-**/.DS_Store
+.vscode
+.DS_Store
+build
+dist

docs/changelog.md

@@ -7,14 +7,14 @@ All notable changes to the `wfmap` package will be documented in this file.
 ### Bug Fixes
 
 - Fix matplotlib warning
-- Fix  Thanks
-- Fix legend display issue in `wif_trends` and add limitation on max plot items
+- Thanks to [@benfroelich](https://github.com/benfroelich), fix bug where wafermap fn wasn't passing on non-default coord col names [#6](https://github.com/xlhaw/wfmap/pull/6)
+- Fix legend display issue in `wif_trends` and add limitation on max items to plot
 
 ### Features
 
 - Add new param `majority` in `wif_trend` for  control
 - Add `wif_corrplot` for correlation plot
-- Documentation Online
+- Documentation Site https://www.wfmap.ml
 
 ## [1.0.2]
 

docs/data.md

@@ -1,6 +1,6 @@
-# Data Guide
+# Data Preparation
 
-This chapter will guide you through the preparation of wafer data. You will get an overview of data format used in `wfmap`, learn the wafer mapping definition and how to merge it with other data source.
+This chapter will guide you through the preparation of wafer data. You will get an overview of the data format used in `wfmap`, learn the wafer mapping definition in detail and how to merge it with other data source.
 
 ## Definition
 
@@ -19,7 +19,9 @@ Wafer mapping definition used in this package is showed in follwing table, which
 
 > `FF` is short for `FlashField`, `WIF` stands for `Within FlashField`.
 
-First two parameters are required in wafer heatmap related plots and succedent 4 parameters are need for trends charts related plots. So please make sure that you have either transformed your data in similar format or pass the correct parameters to corresponding functions.
+!!! warning
+    First two parameters are required in wafer heatmap related plots and succedent 4 parameters are need for trends charts related plots. So please make sure that you have either transformed your data in similar format or pass the correct parameters to corresponding functions.
+
 
 Below is an illustration for above definition.
 

docs/examples/README.md

@@ -1,3 +1,3 @@
 # Example Gallery
 
-This chapter is meant to demonstrate how `wfmap` works at a high level. More detailed information about each parameter is then provided in the [API Reference](https://wfmap.ml/docstrings)
+This page contains example plots that `wfmap` can create. Click on any image to see the full image and source code. More detailed information about each parameter is then provided in the [API Reference](https://wfmap.ml/docstrings)

docs/generated/gallery/index.md

@@ -1,114 +1,130 @@
 <!-- docs_generated_gallery -->
 
-## Started
+# Example Gallery
 
+This page contains example plots that `wfmap` can create. Click on any image to see the full image and source code. More detailed information about each parameter is then provided in the [API Reference](https://wfmap.ml/docstrings)
 
 
-<div class="mkd-glr-thumbcontainer" tooltip="NumHeatmap">
+
+<div class="mkd-glr-thumbcontainer" tooltip="cat_heatmap is essentially a variant of num_heatmap. Internally, the categorical variable is  f...">
     <!--div class="figure align-default" id="id1"-->
-        <img alt="NumHeatmap" src="images/thumb/mkd_glr_plot_0_nheatmap_thumb.png" />
+        <img alt="Categorical Heatmap `cat_heatmap`" src="images/thumb/mkd_glr_plot_1_cheatmap_thumb.png" />
         <p class="caption">
             <span class="caption-text">
-                <a class="reference internal" href="plot_0_nheatmap">
-                    <span class="std std-ref">NumHeatmap</span>
+                <a class="reference internal" href="plot_1_cheatmap">
+                    <span class="std std-ref">Categorical Heatmap `cat_heatmap`</span>
                 </a>
             </span>
             <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->
         </p>
     <!--/div-->
 </div>
 
-<div class="mkd-glr-thumbcontainer" tooltip="CatHeatmap">
+<div class="mkd-glr-thumbcontainer" tooltip="Slightly different from wif_trend, WIF Trends removes the orange area highlight for major distr...">
     <!--div class="figure align-default" id="id1"-->
-        <img alt="CatHeatmap" src="images/thumb/mkd_glr_plot_1_cheatmap_thumb.png" />
+        <img alt="WIF Trends `wif_trends`" src="images/thumb/mkd_glr_plot_6_wif_trends_thumb.png" />
         <p class="caption">
             <span class="caption-text">
-                <a class="reference internal" href="plot_1_cheatmap">
-                    <span class="std std-ref">CatHeatmap</span>
+                <a class="reference internal" href="plot_6_wif_trends">
+                    <span class="std std-ref">WIF Trends `wif_trends`</span>
                 </a>
             </span>
             <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->
         </p>
     <!--/div-->
 </div>
 
-<div class="mkd-glr-thumbcontainer" tooltip="WaferMap uses hot color(red) presents high value and cold value(blue) presents low value.">
+<div class="mkd-glr-thumbcontainer" tooltip="WaferMap add additional color distribution plot and trend charts by row/col around basic NumHea...">
     <!--div class="figure align-default" id="id1"-->
-        <img alt="WaferMap" src="images/thumb/mkd_glr_plot_2_wafermap_thumb.png" />
+        <img alt="WaferMap `wafermap`" src="images/thumb/mkd_glr_plot_2_wafermap_thumb.png" />
         <p class="caption">
             <span class="caption-text">
                 <a class="reference internal" href="plot_2_wafermap">
-                    <span class="std std-ref">WaferMap</span>
+                    <span class="std std-ref">WaferMap `wafermap`</span>
                 </a>
             </span>
             <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->
         </p>
     <!--/div-->
 </div>
 
-<div class="mkd-glr-thumbcontainer" tooltip="This example demonstrates how to import a local module and how images are stacked when two plot...">
+<div class="mkd-glr-thumbcontainer" tooltip="IncomingMap is an horizontal concatenation of multiple WaferMap for wafer incoming data. vsigma...">
     <!--div class="figure align-default" id="id1"-->
-        <img alt="DefectMap" src="images/thumb/mkd_glr_plot_3_defectmap_thumb.png" />
+        <img alt="IncomingMap" src="images/thumb/mkd_glr_plot_4_incmap_thumb.png" />
         <p class="caption">
             <span class="caption-text">
-                <a class="reference internal" href="plot_3_defectmap">
-                    <span class="std std-ref">DefectMap</span>
+                <a class="reference internal" href="plot_4_incmap">
+                    <span class="std std-ref">IncomingMap</span>
                 </a>
             </span>
             <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->
         </p>
     <!--/div-->
 </div>
 
-<div class="mkd-glr-thumbcontainer" tooltip="This example demonstrates how to import a local module and how images are stacked when two plot...">
+<div class="mkd-glr-thumbcontainer" tooltip="WIF Trend gives you a clear view of within flash field &amp; field to field tendency and distributi...">
     <!--div class="figure align-default" id="id1"-->
-        <img alt="IncomingMap" src="images/thumb/mkd_glr_plot_4_incmap_thumb.png" />
+        <img alt="WIF Trend `wif_trend`" src="images/thumb/mkd_glr_plot_5_wif_trend_thumb.png" />
         <p class="caption">
             <span class="caption-text">
-                <a class="reference internal" href="plot_4_incmap">
-                    <span class="std std-ref">IncomingMap</span>
+                <a class="reference internal" href="plot_5_wif_trend">
+                    <span class="std std-ref">WIF Trend `wif_trend`</span>
                 </a>
             </span>
             <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->
         </p>
     <!--/div-->
 </div>
 
-<div class="mkd-glr-thumbcontainer" tooltip="This example demonstrates how to import a local module and how images are stacked when two plot...">
+<div class="mkd-glr-thumbcontainer" tooltip="DefectMap is aimed for defect analysis, beside the defect distribution by cat_heatmap, yield su...">
     <!--div class="figure align-default" id="id1"-->
-        <img alt="WIF Trend" src="images/thumb/mkd_glr_plot_5_wif_trend_thumb.png" />
+        <img alt="DefectMap `defectmap`" src="images/thumb/mkd_glr_plot_3_defectmap_thumb.png" />
         <p class="caption">
             <span class="caption-text">
-                <a class="reference internal" href="plot_5_wif_trend">
-                    <span class="std std-ref">WIF Trend</span>
+                <a class="reference internal" href="plot_3_defectmap">
+                    <span class="std std-ref">DefectMap `defectmap`</span>
                 </a>
             </span>
             <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->
         </p>
     <!--/div-->
 </div>
 
-<div class="mkd-glr-thumbcontainer" tooltip="This example demonstrates how to import a local module and how images are stacked when two plot...">
+<div class="mkd-glr-thumbcontainer" tooltip="wif_corrplot is created to further investigate relationship between two variables. Beside the b...">
     <!--div class="figure align-default" id="id1"-->
-        <img alt="WIF Trends" src="images/thumb/mkd_glr_plot_6_wif_trends_thumb.png" />
+        <img alt="WIF Corrrelation Plot `wif_corrplot`" src="images/thumb/mkd_glr_plot_8_wif_corrplot_thumb.png" />
         <p class="caption">
             <span class="caption-text">
-                <a class="reference internal" href="plot_6_wif_trends">
-                    <span class="std std-ref">WIF Trends</span>
+                <a class="reference internal" href="plot_8_wif_corrplot">
+                    <span class="std std-ref">WIF Corrrelation Plot `wif_corrplot`</span>
                 </a>
             </span>
             <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->
         </p>
     <!--/div-->
 </div>
 
-<div class="mkd-glr-thumbcontainer" tooltip="This example demonstrates how to import a local module and how images are stacked when two plot...">
+<div class="mkd-glr-thumbcontainer" tooltip="Have the advantage of double Y-axis, we&#x27;re able to put two very different variables into same s...">
     <!--div class="figure align-default" id="id1"-->
-        <img alt="TwinY Trends" src="images/thumb/mkd_glr_plot_7_twin_trends_thumb.png" />
+        <img alt="TwinY Trends `twin_trends`" src="images/thumb/mkd_glr_plot_7_twin_trends_thumb.png" />
         <p class="caption">
             <span class="caption-text">
                 <a class="reference internal" href="plot_7_twin_trends">
-                    <span class="std std-ref">TwinY Trends</span>
+                    <span class="std std-ref">TwinY Trends `twin_trends`</span>
+                </a>
+            </span>
+            <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->
+        </p>
+    <!--/div-->
+</div>
+
+<div class="mkd-glr-thumbcontainer" tooltip="num_heatmap uses the colormap jet which present high value with hot color(red) and low value wi...">
+    <!--div class="figure align-default" id="id1"-->
+        <img alt="Numerical Heatmap `num_heatmap`" src="images/thumb/mkd_glr_plot_0_nheatmap_thumb.png" />
+        <p class="caption">
+            <span class="caption-text">
+                <a class="reference internal" href="plot_0_nheatmap">
+                    <span class="std std-ref">Numerical Heatmap `num_heatmap`</span>
                 </a>
             </span>
             <!--a class="headerlink" href="#id1" title="Permalink to this image"></a-->

docs/generated/gallery/mg_execution_times.md

@@ -2,22 +2,24 @@
 
 # Computation times
 
-**00:47.268** total execution time for **generated_gallery** files:
+**00:57.788** total execution time for **generated_gallery** files:
 
-+-------------------------------------------------------------------------------------+-----------+--------+
-| [plot_7_twin_trends](./plot_7_twin_trends.md) (docs/examples/plot_7_twin_trends.py) | 00:21.821 | 0.0 MB |
-+-------------------------------------------------------------------------------------+-----------+--------+
-| [plot_5_wif_trend](./plot_5_wif_trend.md) (docs/examples/plot_5_wif_trend.py)       | 00:05.824 | 0.0 MB |
-+-------------------------------------------------------------------------------------+-----------+--------+
-| [plot_0_nheatmap](./plot_0_nheatmap.md) (docs/examples/plot_0_nheatmap.py)          | 00:05.811 | 0.0 MB |
-+-------------------------------------------------------------------------------------+-----------+--------+
-| [plot_6_wif_trends](./plot_6_wif_trends.md) (docs/examples/plot_6_wif_trends.py)    | 00:04.582 | 0.0 MB |
-+-------------------------------------------------------------------------------------+-----------+--------+
-| [plot_2_wafermap](./plot_2_wafermap.md) (docs/examples/plot_2_wafermap.py)          | 00:03.716 | 0.0 MB |
-+-------------------------------------------------------------------------------------+-----------+--------+
-| [plot_4_incmap](./plot_4_incmap.md) (docs/examples/plot_4_incmap.py)                | 00:02.385 | 0.0 MB |
-+-------------------------------------------------------------------------------------+-----------+--------+
-| [plot_3_defectmap](./plot_3_defectmap.md) (docs/examples/plot_3_defectmap.py)       | 00:01.998 | 0.0 MB |
-+-------------------------------------------------------------------------------------+-----------+--------+
-| [plot_1_cheatmap](./plot_1_cheatmap.md) (docs/examples/plot_1_cheatmap.py)          | 00:01.131 | 0.0 MB |
-+-------------------------------------------------------------------------------------+-----------+--------+
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_1_cheatmap](./plot_1_cheatmap.md) (docs/examples/plot_1_cheatmap.py)             | 00:36.984 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_8_wif_corrplot](./plot_8_wif_corrplot.md) (docs/examples/plot_8_wif_corrplot.py) | 00:05.227 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_7_twin_trends](./plot_7_twin_trends.md) (docs/examples/plot_7_twin_trends.py)    | 00:04.586 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_5_wif_trend](./plot_5_wif_trend.md) (docs/examples/plot_5_wif_trend.py)          | 00:03.888 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_6_wif_trends](./plot_6_wif_trends.md) (docs/examples/plot_6_wif_trends.py)       | 00:03.681 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_2_wafermap](./plot_2_wafermap.md) (docs/examples/plot_2_wafermap.py)             | 00:00.969 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_4_incmap](./plot_4_incmap.md) (docs/examples/plot_4_incmap.py)                   | 00:00.955 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_0_nheatmap](./plot_0_nheatmap.md) (docs/examples/plot_0_nheatmap.py)             | 00:00.793 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+
+| [plot_3_defectmap](./plot_3_defectmap.md) (docs/examples/plot_3_defectmap.py)          | 00:00.706 | 0.0 MB |
++----------------------------------------------------------------------------------------+-----------+--------+