fix tutorial

aim-lab · Jun 6, 2023 · fe59e36 · fe59e36
1 parent 7d30dad
commit fe59e36
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 62 deletions.
diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
diff --git a/docs/build/.doctrees/pecg.doctree b/docs/build/.doctrees/pecg.doctree
diff --git a/docs/build/_sources/pecg.rst.txt b/docs/build/_sources/pecg.rst.txt
@@ -1,11 +1,6 @@
 pecg package
 ============
 
-.. toctree::
-   :maxdepth: 4
-
-   pecg.ecg
-
 
 pecg.Preprocessing
 --------------------------
@@ -23,6 +18,11 @@ pecg.Example
    :undoc-members:
    :show-inheritance:
 
+.. toctree::
+   :maxdepth: 4
+
+   pecg.ecg
+
 
 
 Module contents

diff --git a/docs/build/index.html b/docs/build/index.html
@@ -222,18 +222,6 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to
 <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pecg.html">pecg package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html">pecg.ecg package</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.FiducialPoints">pecg.ecg.FiducialPoints</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints"><code class="docutils literal notranslate"><span class="pre">FiducialPoints</span></code></a></li>
-</ul>
-</li>
-<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.Biomarkers">pecg.ecg.Biomarkers</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers"><code class="docutils literal notranslate"><span class="pre">Biomarkers</span></code></a></li>
-</ul>
-</li>
-<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg">Module contents</a></li>
-</ul>
-</li>
 <li class="toctree-l2"><a class="reference internal" href="pecg.html#module-pecg.Preprocessing">pecg.Preprocessing</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="pecg.html#pecg.Preprocessing.Preprocessing"><code class="docutils literal notranslate"><span class="pre">Preprocessing</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pecg.html#pecg.Preprocessing.Preprocessing.notch"><code class="docutils literal notranslate"><span class="pre">Preprocessing.notch()</span></code></a></li>
@@ -245,6 +233,12 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to
 </li>
 <li class="toctree-l2"><a class="reference internal" href="pecg.html#module-pecg.Example">pecg.Example</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="pecg.html#pecg.Example.load_example"><code class="docutils literal notranslate"><span class="pre">load_example()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html">pecg.ecg package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.FiducialPoints">pecg.ecg.FiducialPoints</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.Biomarkers">pecg.ecg.Biomarkers</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg">Module contents</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="pecg.html#module-pecg">Module contents</a></li>

diff --git a/docs/build/modules.html b/docs/build/modules.html
@@ -169,18 +169,6 @@ <h1>pecg<a class="headerlink" href="#pecg" title="Permalink to this heading">¶<
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pecg.html">pecg package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html">pecg.ecg package</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.FiducialPoints">pecg.ecg.FiducialPoints</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints"><code class="docutils literal notranslate"><span class="pre">FiducialPoints</span></code></a></li>
-</ul>
-</li>
-<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.Biomarkers">pecg.ecg.Biomarkers</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers"><code class="docutils literal notranslate"><span class="pre">Biomarkers</span></code></a></li>
-</ul>
-</li>
-<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg">Module contents</a></li>
-</ul>
-</li>
 <li class="toctree-l2"><a class="reference internal" href="pecg.html#module-pecg.Preprocessing">pecg.Preprocessing</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="pecg.html#pecg.Preprocessing.Preprocessing"><code class="docutils literal notranslate"><span class="pre">Preprocessing</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pecg.html#pecg.Preprocessing.Preprocessing.notch"><code class="docutils literal notranslate"><span class="pre">Preprocessing.notch()</span></code></a></li>
@@ -192,6 +180,12 @@ <h1>pecg<a class="headerlink" href="#pecg" title="Permalink to this heading">¶<
 </li>
 <li class="toctree-l2"><a class="reference internal" href="pecg.html#module-pecg.Example">pecg.Example</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="pecg.html#pecg.Example.load_example"><code class="docutils literal notranslate"><span class="pre">load_example()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html">pecg.ecg package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.FiducialPoints">pecg.ecg.FiducialPoints</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.Biomarkers">pecg.ecg.Biomarkers</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg">Module contents</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="pecg.html#module-pecg">Module contents</a></li>

diff --git a/docs/build/pecg.html b/docs/build/pecg.html
@@ -95,7 +95,6 @@
               <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">pecg package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html">pecg.ecg package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#module-pecg.Preprocessing">pecg.Preprocessing</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#pecg.Preprocessing.Preprocessing"><code class="docutils literal notranslate"><span class="pre">Preprocessing</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#pecg.Preprocessing.Preprocessing.notch"><code class="docutils literal notranslate"><span class="pre">Preprocessing.notch()</span></code></a></li>
@@ -107,6 +106,7 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#module-pecg.Example">pecg.Example</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#pecg.Example.load_example"><code class="docutils literal notranslate"><span class="pre">load_example()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html">pecg.ecg package</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#module-pecg">Module contents</a></li>
@@ -185,32 +185,6 @@
 
   <div class="section" id="pecg-package">
 <h1>pecg package<a class="headerlink" href="#pecg-package" title="Permalink to this heading">¶</a></h1>
-<div class="toctree-wrapper compound">
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="pecg.ecg.html">pecg.ecg package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.FiducialPoints">pecg.ecg.FiducialPoints</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints"><code class="docutils literal notranslate"><span class="pre">FiducialPoints</span></code></a><ul>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints.wavedet"><code class="docutils literal notranslate"><span class="pre">FiducialPoints.wavedet()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints.epltd"><code class="docutils literal notranslate"><span class="pre">FiducialPoints.epltd()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints.xqrs"><code class="docutils literal notranslate"><span class="pre">FiducialPoints.xqrs()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints.jqrs"><code class="docutils literal notranslate"><span class="pre">FiducialPoints.jqrs()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.Biomarkers">pecg.ecg.Biomarkers</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers"><code class="docutils literal notranslate"><span class="pre">Biomarkers</span></code></a><ul>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers.intervals"><code class="docutils literal notranslate"><span class="pre">Biomarkers.intervals()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers.waves"><code class="docutils literal notranslate"><span class="pre">Biomarkers.waves()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg">Module contents</a></li>
-</ul>
-</li>
-</ul>
-</div>
 <div class="section" id="module-pecg.Preprocessing">
 <span id="pecg-preprocessing"></span><h2>pecg.Preprocessing<a class="headerlink" href="#module-pecg.Preprocessing" title="Permalink to this heading">¶</a></h2>
 <dl class="py class">
@@ -330,6 +304,32 @@ <h1>pecg package<a class="headerlink" href="#pecg-package" title="Permalink to t
 </div></blockquote>
 </dd></dl>
 
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="pecg.ecg.html">pecg.ecg package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.FiducialPoints">pecg.ecg.FiducialPoints</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints"><code class="docutils literal notranslate"><span class="pre">FiducialPoints</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints.wavedet"><code class="docutils literal notranslate"><span class="pre">FiducialPoints.wavedet()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints.epltd"><code class="docutils literal notranslate"><span class="pre">FiducialPoints.epltd()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints.xqrs"><code class="docutils literal notranslate"><span class="pre">FiducialPoints.xqrs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.FiducialPoints.FiducialPoints.jqrs"><code class="docutils literal notranslate"><span class="pre">FiducialPoints.jqrs()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg.Biomarkers">pecg.ecg.Biomarkers</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers"><code class="docutils literal notranslate"><span class="pre">Biomarkers</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers.intervals"><code class="docutils literal notranslate"><span class="pre">Biomarkers.intervals()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers.waves"><code class="docutils literal notranslate"><span class="pre">Biomarkers.waves()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="pecg.ecg.html#module-pecg.ecg">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
 </div>
 <div class="section" id="module-pecg">
 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pecg" title="Permalink to this heading">¶</a></h2>

diff --git a/docs/build/searchindex.js b/docs/build/searchindex.js
diff --git a/docs/pecg.rst b/docs/pecg.rst
@@ -1,11 +1,6 @@
 pecg package
 ============
 
-.. toctree::
-   :maxdepth: 4
-
-   pecg.ecg
-
 
 pecg.Preprocessing
 --------------------------
@@ -23,6 +18,11 @@ pecg.Example
    :undoc-members:
    :show-inheritance:
 
+.. toctree::
+   :maxdepth: 4
+
+   pecg.ecg
+
 
 
 Module contents