rtd added

aim-lab · Nov 16, 2022 · 293c5ce · 293c5ce
1 parent 1393d97
commit 293c5ce
Show file tree

Hide file tree

Showing 17 changed files with 36 additions and 28 deletions.
diff --git a/docs/build/.doctrees/README.doctree b/docs/build/.doctrees/README.doctree
diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
diff --git a/docs/build/.doctrees/index.doctree b/docs/build/.doctrees/index.doctree
diff --git a/docs/build/.doctrees/pecg.ecg.doctree b/docs/build/.doctrees/pecg.ecg.doctree
diff --git a/docs/build/README.html b/docs/build/README.html
@@ -90,7 +90,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM API REFERENCE:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pecg.html">pecg package</a></li>
 </ul>
@@ -186,7 +186,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">¶</a></h2>
 <p>Available on pip, with the command:
 pip install pebm</p>
-<p>pip project: pip install -i <a class="reference external" href="https://test.pypi.org/simple/">https://test.pypi.org/simple/</a> pecg</p>
+<p>pip project: pip install pecg</p>
 </div>
 <div class="section" id="requirements">
 <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
@@ -204,6 +204,7 @@ <h2>System Requirements<a class="headerlink" href="#system-requirements" title="
 </div>
 <div class="section" id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">¶</a></h2>
+<p><a class="reference external" href="https://pecg.readthedocs.io/en/latest/">https://pecg.readthedocs.io/en/latest/</a></p>
 </div>
 </div>
 

diff --git a/docs/build/_modules/index.html b/docs/build/_modules/index.html
@@ -90,7 +90,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM API REFERENCE:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../pecg.html">pecg package</a></li>
 </ul>

diff --git a/docs/build/_modules/pecg/ecg/Biomarkers.html b/docs/build/_modules/pecg/ecg/Biomarkers.html
@@ -90,7 +90,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM API REFERENCE:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../pecg.html">pecg package</a></li>
 </ul>
@@ -199,8 +199,8 @@ <h1>Source code for pecg.ecg.Biomarkers</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="Biomarkers.intervals"><a class="viewcode-back" href="../../../pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers.intervals">[docs]</a>    <span class="k">def</span> <span class="nf">intervals</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        :return:</span>
-<span class="sd">            *intervals_b: Dictionary that includes all the row data, for the **Interval duration and segments** biomarkers.</span>
-<span class="sd">            *intervals_statistics: Dictionary that includes the mean, median, min, max, iqr and std, for every **Interval duration and segments** biomarker.</span>
+<span class="sd">            * intervals_b: Dictionary that includes all the row data, for the **Interval duration and segments** biomarkers.</span>
+<span class="sd">            * intervals_statistics: Dictionary that includes the mean, median, min, max, iqr and std, for every **Interval duration and segments** biomarker.</span>
 
 
 <span class="sd">        .. list-table:: **Interval duration and segments**:</span>
@@ -270,8 +270,8 @@ <h1>Source code for pecg.ecg.Biomarkers</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="Biomarkers.waves"><a class="viewcode-back" href="../../../pecg.ecg.html#pecg.ecg.Biomarkers.Biomarkers.waves">[docs]</a>    <span class="k">def</span> <span class="nf">waves</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        :return:</span>
-<span class="sd">            *waves_b: Dictionary that includes all the row data, for every **Waves characteristic** biomarker.</span>
-<span class="sd">            *waves_statistics: Dictionary that includes the mean, median, min, max, iqr and std, for every **Waves characteristic** biomarker.</span>
+<span class="sd">            * waves_b: Dictionary that includes all the row data, for every **Waves characteristic** biomarker.</span>
+<span class="sd">            * waves_statistics: Dictionary that includes the mean, median, min, max, iqr and std, for every **Waves characteristic** biomarker.</span>
 
 
 <span class="sd">        .. list-table:: **Waves characteristics**:</span>

diff --git a/docs/build/_sources/README.rst.txt b/docs/build/_sources/README.rst.txt
@@ -34,7 +34,7 @@ Installation
 Available on pip, with the command: 
 pip install pebm
 
-pip project: pip install -i https://test.pypi.org/simple/ pecg
+pip project: pip install pecg
 
 Requirements
 -----------------------
@@ -61,4 +61,4 @@ To run the epltd peak detector additional wfdb toolbox is requierd. https://arch
 Documentation
 ------------------------
 
-
+https://pecg.readthedocs.io/en/latest/
diff --git a/docs/build/_sources/index.rst.txt b/docs/build/_sources/index.rst.txt
@@ -7,7 +7,7 @@
 
 .. toctree::
    :maxdepth: 4
-   :caption: PECG API REFERENCE:
+   :caption: POBM API REFERENCE:
 
    pecg
 

diff --git a/docs/build/genindex.html b/docs/build/genindex.html
@@ -90,7 +90,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM API REFERENCE:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pecg.html">pecg package</a></li>
 </ul>

diff --git a/docs/build/index.html b/docs/build/index.html
@@ -91,7 +91,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM API REFERENCE:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pecg.html">pecg package</a></li>
 </ul>
@@ -187,7 +187,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">¶</a></h2>
 <p>Available on pip, with the command:
 pip install pebm</p>
-<p>pip project: pip install -i <a class="reference external" href="https://test.pypi.org/simple/">https://test.pypi.org/simple/</a> pecg</p>
+<p>pip project: pip install pecg</p>
 </div>
 <div class="section" id="requirements">
 <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
@@ -205,8 +205,9 @@ <h2>System Requirements<a class="headerlink" href="#system-requirements" title="
 </div>
 <div class="section" id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">¶</a></h2>
+<p><a class="reference external" href="https://pecg.readthedocs.io/en/latest/">https://pecg.readthedocs.io/en/latest/</a></p>
 <div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+<p class="caption" role="heading"><span class="caption-text">POBM 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>

diff --git a/docs/build/pecg.ecg.html b/docs/build/pecg.ecg.html
@@ -91,7 +91,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM API REFERENCE:</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="reference internal" href="pecg.html">pecg package</a><ul class="current">
 <li class="toctree-l2 current"><a class="current reference internal" href="#">pecg.ecg package</a><ul>
@@ -327,8 +327,11 @@ <h1>pecg.ecg package<a class="headerlink" href="#pecg-ecg-package" title="Permal
 <span class="sig-name descname"><span class="pre">intervals</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pecg/ecg/Biomarkers.html#Biomarkers.intervals"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pecg.ecg.Biomarkers.Biomarkers.intervals" title="Permalink to this definition">¶</a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Returns</dt>
-<dd class="field-odd"><p><em>intervals_b: Dictionary that includes all the row data, for the **Interval duration and segments*</em> biomarkers.
-<em>intervals_statistics: Dictionary that includes the mean, median, min, max, iqr and std, for every **Interval duration and segments*</em> biomarker.</p>
+<dd class="field-odd"><p><ul class="simple">
+<li><p>intervals_b: Dictionary that includes all the row data, for the <strong>Interval duration and segments</strong> biomarkers.</p></li>
+<li><p>intervals_statistics: Dictionary that includes the mean, median, min, max, iqr and std, for every <strong>Interval duration and segments</strong> biomarker.</p></li>
+</ul>
+</p>
 </dd>
 </dl>
 <table class="colwidths-given docutils align-default" id="id8">
@@ -394,8 +397,11 @@ <h1>pecg.ecg package<a class="headerlink" href="#pecg-ecg-package" title="Permal
 <span class="sig-name descname"><span class="pre">waves</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pecg/ecg/Biomarkers.html#Biomarkers.waves"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pecg.ecg.Biomarkers.Biomarkers.waves" title="Permalink to this definition">¶</a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Returns</dt>
-<dd class="field-odd"><p><em>waves_b: Dictionary that includes all the row data, for every **Waves characteristic*</em> biomarker.
-<em>waves_statistics: Dictionary that includes the mean, median, min, max, iqr and std, for every **Waves characteristic*</em> biomarker.</p>
+<dd class="field-odd"><p><ul class="simple">
+<li><p>waves_b: Dictionary that includes all the row data, for every <strong>Waves characteristic</strong> biomarker.</p></li>
+<li><p>waves_statistics: Dictionary that includes the mean, median, min, max, iqr and std, for every <strong>Waves characteristic</strong> biomarker.</p></li>
+</ul>
+</p>
 </dd>
 </dl>
 <table class="colwidths-given docutils align-default" id="id9">

diff --git a/docs/build/pecg.html b/docs/build/pecg.html
@@ -92,7 +92,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM 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>

diff --git a/docs/build/py-modindex.html b/docs/build/py-modindex.html
@@ -93,7 +93,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM API REFERENCE:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pecg.html">pecg package</a></li>
 </ul>

diff --git a/docs/build/search.html b/docs/build/search.html
@@ -93,7 +93,7 @@
 
 
 
-              <p class="caption" role="heading"><span class="caption-text">PECG API REFERENCE:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">POBM API REFERENCE:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pecg.html">pecg package</a></li>
 </ul>