update docs

Author: arch

docs/app/site/index.html

@@ -204,5 +204,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.1.2
-Build Date UTC : 2021-07-03 08:25:01.317170+00:00
+Build Date UTC : 2021-07-03 18:15:39.307380+00:00
 -->

docs/app/site/search/search_index.json

@@ -126,6 +126,7 @@ <h2 id="config-files">Config Files</h2>
 <h3 id="config-parameter">Config Parameter</h3>
 <h4 id="settingsyaml"><code>settings.yaml</code></h4>
 <ul>
+<li><code>use_kalman_filter</code>: Enable Kalman Filter</li>
 <li><code>use_zoom</code> (bool): Enable or disable an additional step to zoom in the Video before selecting a tracking feature for the Woman or Men.</li>
 <li><code>zoom_factor:</code> (float): Set the desired zoom value which will be used when the zoom function is activated.</li>
 <li><code>tracking_direction</code> (str): Specify the tracking direction. Allowed values are <code>'x'</code> and <code>'y'</code>.</li>

docs/app/site/sitemap.xml.gz

@@ -123,7 +123,7 @@ <h2 id="installation-windows">Installation (Windows)</h2>
 <li>Download the <strong>latest</strong> <code>funscript_generator.lua</code> script from <a href="https://github.com/michael-mueller-git/Python-Funscript-Editor/releases">github release page</a>.</li>
 <li>Move the downloaded <code>funscript_generator.lua</code> script to <code>data/lua</code> in your OFS directory.</li>
 <li>Open the <code>funscript_generator.lua</code> file and adjust the <code>Settings.FunscriptGenerator</code> and <code>Settings.TmpFile</code> variable.</li>
-<li><strong>NOTE:</strong> You have to use use <code>/</code> or <code>\\</code> for the <code>\</code> symbols in your path!</li>
+<li><strong>NOTE:</strong> If you copy the path from Windows explorer to the variable in the lua script you have to escape the <code>\</code> symbol. This mean you have to put another <code>\</code> in front of each <code>\</code> so that there are always <code>\\</code> pairs. As an alternative, you can use a simple <code>/</code> instead of the single <code>\</code> Symbole that also work.</li>
 <li><code>Settings.FunscriptGenerator</code>: Point to the extracted Python Funscript Editor program (better double check the complete path string to avoid errors later on).</li>
 <li><code>Settings.TmpFile</code>: Specifies a temporary file location where to store the result (must be a file not a directory!). The file does not have to exist at the moment. The specified file will be generated from the Python Funscript Editor and will be overwritten automatically at the next time the generator is started!</li>
 <li>Now launch OFS.</li>

docs/app/site/user-guide/config/index.html

@@ -12,6 +12,14 @@ funscript\_editor.algorithms.funscriptgenerator module
    :undoc-members:
    :show-inheritance:
 
+funscript\_editor.algorithms.kalmanfilter module
+------------------------------------------------
+
+.. automodule:: funscript_editor.algorithms.kalmanfilter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 funscript\_editor.algorithms.signalprocessing module
 ----------------------------------------------------