Update documentation

Author: salu133445

docs/_modules/pypianoroll/plot.html

@@ -332,8 +332,8 @@ <h1>Source code for pypianoroll.utilities</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="plot"><a class="viewcode-back" href="../../visualization.html#pypianoroll.plot">[docs]</a><span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Plot the object. See :func:`pypianoroll.Multitrack.plot` and</span>
-<span class="sd">    :func:`pypianoroll.Track.plot` for full documentation.</span>
+<span class="sd">    Plot the object. See :func:`pypianoroll.plot.plot_multitrack` and</span>
+<span class="sd">    :func:`pypianoroll.plot.plot_track` for full documentation.</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">_check_supported</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>

docs/_modules/pypianoroll/utilities.html

@@ -4,7 +4,7 @@ Save & Load
 ===========
 Pypianoroll supports efficient utilities for saving and loading
 :class:`pypianoroll.Multitrack` objects. The piano-rolls will be first converted
-to instances of ``scipy.sparse.csc_matrix`` and then stored in a .npz file.
+to instances of :class:`scipy.sparse.csc_matrix` and then stored in a .npz file.
 
 .. autofunction:: pypianoroll.save
 

docs/_sources/save_load.rst.txt

@@ -21,6 +21,8 @@ Here are some examples.
 Related Functions
 -----------------
 
-.. autofunction :: pypianoroll.plot_pianoroll
 .. autofunction :: pypianoroll.plot
+.. autofunction :: pypianoroll.plot_pianoroll
+.. autofunction :: pypianoroll.plot.plot_track
+.. autofunction :: pypianoroll.plot.plot_multitrack
 .. autofunction :: pypianoroll.save_animation

docs/_sources/visualization.rst.txt

@@ -361,10 +361,10 @@ <h2 id="P">P</h2>
         <li><a href="multitrack.html#pypianoroll.Multitrack.pad_to_same">(pypianoroll.Multitrack method)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="parse_write.html#pypianoroll.parse">parse() (in module pypianoroll)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="multitrack.html#pypianoroll.Multitrack.parse_midi">parse_midi() (pypianoroll.Multitrack method)</a>
 </li>
       <li><a href="multitrack.html#pypianoroll.Multitrack.parse_pretty_midi">parse_pretty_midi() (pypianoroll.Multitrack method)</a>
@@ -379,7 +379,11 @@ <h2 id="P">P</h2>
         <li><a href="track.html#pypianoroll.Track.plot">(pypianoroll.Track method)</a>
 </li>
       </ul></li>
+      <li><a href="visualization.html#pypianoroll.plot.plot_multitrack">plot_multitrack() (in module pypianoroll.plot)</a>
+</li>
       <li><a href="visualization.html#pypianoroll.plot_pianoroll">plot_pianoroll() (in module pypianoroll)</a>
+</li>
+      <li><a href="visualization.html#pypianoroll.plot.plot_track">plot_track() (in module pypianoroll.plot)</a>
 </li>
       <li><a href="track.html#pypianoroll.Track.program">program (pypianoroll.Track attribute)</a>
 </li>

docs/genindex.html

@@ -657,7 +657,7 @@
 <dt id="pypianoroll.Multitrack.plot">
 <code class="descname">plot</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypianoroll/multitrack.html#Multitrack.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypianoroll.Multitrack.plot" title="Permalink to this definition">¶</a></dt>
 <dd><p>Plot the piano-rolls or save a plot of them. See
-<code class="xref py py-func docutils literal"><span class="pre">pypianoroll.plot.plot_multitrack()</span></code> for full documentation.</p>
+<a class="reference internal" href="visualization.html#pypianoroll.plot.plot_multitrack" title="pypianoroll.plot.plot_multitrack"><code class="xref py py-func docutils literal"><span class="pre">pypianoroll.plot.plot_multitrack()</span></code></a> for full documentation.</p>
 </dd></dl>
 
 <dl class="method">

docs/multitrack.html

@@ -163,7 +163,7 @@
 <span id="id1"></span><h1>Save &amp; Load<a class="headerlink" href="#save-load" title="Permalink to this headline">¶</a></h1>
 <p>Pypianoroll supports efficient utilities for saving and loading
 <a class="reference internal" href="multitrack.html#pypianoroll.Multitrack" title="pypianoroll.Multitrack"><code class="xref py py-class docutils literal"><span class="pre">pypianoroll.Multitrack</span></code></a> objects. The piano-rolls will be first converted
-to instances of <code class="docutils literal"><span class="pre">scipy.sparse.csc_matrix</span></code> and then stored in a .npz file.</p>
+to instances of <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csc_matrix.html#scipy.sparse.csc_matrix" title="(in SciPy v1.1.0)"><code class="xref py py-class docutils literal"><span class="pre">scipy.sparse.csc_matrix</span></code></a> and then stored in a .npz file.</p>
 <dl class="function">
 <dt id="pypianoroll.save">
 <code class="descclassname">pypianoroll.</code><code class="descname">save</code><span class="sig-paren">(</span><em>filepath</em>, <em>obj</em>, <em>compressed=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypianoroll/utilities.html#save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypianoroll.save" title="Permalink to this definition">¶</a></dt>

docs/objects.inv

@@ -380,7 +380,7 @@
 <dt id="pypianoroll.Track.plot">
 <code class="descname">plot</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypianoroll/track.html#Track.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypianoroll.Track.plot" title="Permalink to this definition">¶</a></dt>
 <dd><p>Plot the piano-roll or save a plot of the piano-roll. See
-<code class="xref py py-func docutils literal"><span class="pre">pypianoroll.plot.plot_track()</span></code> for full documentation.</p>
+<a class="reference internal" href="visualization.html#pypianoroll.plot.plot_track" title="pypianoroll.plot.plot_track"><code class="xref py py-func docutils literal"><span class="pre">pypianoroll.plot.plot_track()</span></code></a> for full documentation.</p>
 </dd></dl>
 
 <dl class="method">