Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@rosskouk
rosskouk committed Oct 22, 2022
1 parent a316b7b commit 001839e
Show file tree
Hide file tree
Showing 6 changed files with 98 additions and 21 deletions.
4 changes: 3 additions & 1 deletion docs/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ Supported Intents
+-------------------------------------------+--------------------------------------------+-------------------------------------+
| :class:`~app.NaviSonicPlayFavouriteSongs` | Play your starred / favourite songs | Play my favourite songs |
+-------------------------------------------+--------------------------------------------+-------------------------------------+
| :class:`~app.NaviSonicRandomiseQueue` | Shuffle / randomise the current play queue | Shuffle the queue |
+-------------------------------------------+--------------------------------------------+-------------------------------------+
| :class:`~app.NaviSonicSongDetails` | Give details on the playing track | What is playing |
+-------------------------------------------+--------------------------------------------+-------------------------------------+
| :class:`~app.NaviSonicStarSong` | Star / favourite a song | Star this song |
Expand Down Expand Up @@ -413,7 +415,7 @@ Code Documentation
******************

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Contents:

AskNavidrome main
Expand Down
10 changes: 8 additions & 2 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ <h2 id="C">C</h2>
<li><a href="index.html#app.NaviSonicPlayPlaylist.can_handle">(app.NaviSonicPlayPlaylist method)</a>
</li>
<li><a href="index.html#app.NaviSonicPlaySongByArtist.can_handle">(app.NaviSonicPlaySongByArtist method)</a>
</li>
<li><a href="index.html#app.NaviSonicRandomiseQueue.can_handle">(app.NaviSonicRandomiseQueue method)</a>
</li>
<li><a href="index.html#app.NaviSonicSongDetails.can_handle">(app.NaviSonicSongDetails method)</a>
</li>
Expand Down Expand Up @@ -233,6 +235,8 @@ <h2 id="H">H</h2>
<li><a href="index.html#app.NaviSonicPlayPlaylist.handle">(app.NaviSonicPlayPlaylist method)</a>
</li>
<li><a href="index.html#app.NaviSonicPlaySongByArtist.handle">(app.NaviSonicPlaySongByArtist method)</a>
</li>
<li><a href="index.html#app.NaviSonicRandomiseQueue.handle">(app.NaviSonicRandomiseQueue method)</a>
</li>
<li><a href="index.html#app.NaviSonicSongDetails.handle">(app.NaviSonicSongDetails method)</a>
</li>
Expand Down Expand Up @@ -318,11 +322,13 @@ <h2 id="N">N</h2>
</li>
<li><a href="index.html#app.NaviSonicPlayMusicRandom">NaviSonicPlayMusicRandom (class in app)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#app.NaviSonicPlayPlaylist">NaviSonicPlayPlaylist (class in app)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#app.NaviSonicPlaySongByArtist">NaviSonicPlaySongByArtist (class in app)</a>
</li>
<li><a href="index.html#app.NaviSonicRandomiseQueue">NaviSonicRandomiseQueue (class in app)</a>
</li>
<li><a href="index.html#app.NaviSonicSongDetails">NaviSonicSongDetails (class in app)</a>
</li>
Expand Down
103 changes: 86 additions & 17 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,19 @@ <h2>Supported Intents<a class="headerlink" href="#supported-intents" title="Perm
<td><p>Play your starred / favourite songs</p></td>
<td><p>Play my favourite songs</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicSongDetails" title="app.NaviSonicSongDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">NaviSonicSongDetails</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicRandomiseQueue" title="app.NaviSonicRandomiseQueue"><code class="xref py py-class docutils literal notranslate"><span class="pre">NaviSonicRandomiseQueue</span></code></a></p></td>
<td><p>Shuffle / randomise the current play queue</p></td>
<td><p>Shuffle the queue</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NaviSonicSongDetails" title="app.NaviSonicSongDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">NaviSonicSongDetails</span></code></a></p></td>
<td><p>Give details on the playing track</p></td>
<td><p>What is playing</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NaviSonicStarSong" title="app.NaviSonicStarSong"><code class="xref py py-class docutils literal notranslate"><span class="pre">NaviSonicStarSong</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicStarSong" title="app.NaviSonicStarSong"><code class="xref py py-class docutils literal notranslate"><span class="pre">NaviSonicStarSong</span></code></a></p></td>
<td><p>Star / favourite a song</p></td>
<td><p>Star this song</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicUnstarSong" title="app.NaviSonicUnstarSong"><code class="xref py py-class docutils literal notranslate"><span class="pre">NaviSonicUnstarSong</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NaviSonicUnstarSong" title="app.NaviSonicUnstarSong"><code class="xref py py-class docutils literal notranslate"><span class="pre">NaviSonicUnstarSong</span></code></a></p></td>
<td><p>Unstar / unfavourite a song</p></td>
<td><p>Unstar this song</p></td>
</tr>
Expand Down Expand Up @@ -498,46 +502,49 @@ <h2>Code Documentation<a class="headerlink" href="#code-documentation" title="Pe
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicPlaySongByArtist" title="app.NaviSonicPlaySongByArtist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NaviSonicPlaySongByArtist</span></code></a>()</p></td>
<td><p>Handle the NaviSonicPlaySongByArtist intent</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NaviSonicSongDetails" title="app.NaviSonicSongDetails"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NaviSonicSongDetails</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NaviSonicRandomiseQueue" title="app.NaviSonicRandomiseQueue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NaviSonicRandomiseQueue</span></code></a>()</p></td>
<td><p>Handle NaviSonicRandomiseQueue Intent</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicSongDetails" title="app.NaviSonicSongDetails"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NaviSonicSongDetails</span></code></a>()</p></td>
<td><p>Handle NaviSonicSongDetails Intent</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicStarSong" title="app.NaviSonicStarSong"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NaviSonicStarSong</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NaviSonicStarSong" title="app.NaviSonicStarSong"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NaviSonicStarSong</span></code></a>()</p></td>
<td><p>Handle NaviSonicStarSong Intent</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NaviSonicUnstarSong" title="app.NaviSonicUnstarSong"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NaviSonicUnstarSong</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicUnstarSong" title="app.NaviSonicUnstarSong"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NaviSonicUnstarSong</span></code></a>()</p></td>
<td><p>Handle NaviSonicUnstarSong Intent</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NextPlaybackHandler" title="app.NextPlaybackHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NextPlaybackHandler</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NextPlaybackHandler" title="app.NextPlaybackHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NextPlaybackHandler</span></code></a>()</p></td>
<td><p>Handle NextIntent</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.PausePlaybackHandler" title="app.PausePlaybackHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PausePlaybackHandler</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.PausePlaybackHandler" title="app.PausePlaybackHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PausePlaybackHandler</span></code></a>()</p></td>
<td><p>Handler for stopping audio.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.PlaybackFailedEventHandler" title="app.PlaybackFailedEventHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackFailedEventHandler</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.PlaybackFailedEventHandler" title="app.PlaybackFailedEventHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackFailedEventHandler</span></code></a>()</p></td>
<td><p>AudioPlayer.PlaybackFailed Directive received.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.PlaybackFinishedHandler" title="app.PlaybackFinishedHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackFinishedHandler</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.PlaybackFinishedHandler" title="app.PlaybackFinishedHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackFinishedHandler</span></code></a>()</p></td>
<td><p>AudioPlayer.PlaybackFinished Directive received.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.PlaybackNearlyFinishedHandler" title="app.PlaybackNearlyFinishedHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackNearlyFinishedHandler</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.PlaybackNearlyFinishedHandler" title="app.PlaybackNearlyFinishedHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackNearlyFinishedHandler</span></code></a>()</p></td>
<td><p>AudioPlayer.PlaybackNearlyFinished Directive received.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.PlaybackStartedHandler" title="app.PlaybackStartedHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackStartedHandler</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.PlaybackStartedHandler" title="app.PlaybackStartedHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackStartedHandler</span></code></a>()</p></td>
<td><p>AudioPlayer.PlaybackStarted Directive received.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.PlaybackStoppedHandler" title="app.PlaybackStoppedHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackStoppedHandler</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.PlaybackStoppedHandler" title="app.PlaybackStoppedHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlaybackStoppedHandler</span></code></a>()</p></td>
<td><p>AudioPlayer.PlaybackStopped Directive received.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.PreviousPlaybackHandler" title="app.PreviousPlaybackHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PreviousPlaybackHandler</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.PreviousPlaybackHandler" title="app.PreviousPlaybackHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PreviousPlaybackHandler</span></code></a>()</p></td>
<td><p>Handle PreviousIntent</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.ResumePlaybackHandler" title="app.ResumePlaybackHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ResumePlaybackHandler</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.ResumePlaybackHandler" title="app.ResumePlaybackHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ResumePlaybackHandler</span></code></a>()</p></td>
<td><p>Handler for resuming audio on different events.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.SkillEventHandler" title="app.SkillEventHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SkillEventHandler</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.SkillEventHandler" title="app.SkillEventHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SkillEventHandler</span></code></a>()</p></td>
<td><p>Close session for skill events or when session ends.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.SystemExceptionHandler" title="app.SystemExceptionHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SystemExceptionHandler</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#app.SystemExceptionHandler" title="app.SystemExceptionHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SystemExceptionHandler</span></code></a>()</p></td>
<td><p>Handle System.ExceptionEncountered</p></td>
</tr>
</tbody>
Expand Down Expand Up @@ -1249,6 +1256,63 @@ <h2>Code Documentation<a class="headerlink" href="#code-documentation" title="Pe

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="app.NaviSonicRandomiseQueue">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">NaviSonicRandomiseQueue</span></span><a class="headerlink" href="#app.NaviSonicRandomiseQueue" title="Permalink to this definition"></a></dt>
<dd><p>Handle NaviSonicRandomiseQueue Intent</p>
<p>Shuffle the current play queue</p>
<p><strong>Methods:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.NaviSonicRandomiseQueue.can_handle" title="app.NaviSonicRandomiseQueue.can_handle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">can_handle</span></code></a>(handler_input)</p></td>
<td><p>Returns true if Request Handler can handle the Request inside Handler Input.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.NaviSonicRandomiseQueue.handle" title="app.NaviSonicRandomiseQueue.handle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">handle</span></code></a>(handler_input)</p></td>
<td><p>Handles the Request inside handler input and provides a Response for dispatcher to return.</p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="app.NaviSonicRandomiseQueue.can_handle">
<span class="sig-name descname"><span class="pre">can_handle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler_input</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">HandlerInput</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#app.NaviSonicRandomiseQueue.can_handle" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if Request Handler can handle the Request
inside Handler Input.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>handler_input</strong> (<em>HandlerInput</em>) – Handler Input instance with
Request Envelope containing Request.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Boolean value that tells the dispatcher if the
current request can be handled by this handler.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="app.NaviSonicRandomiseQueue.handle">
<span class="sig-name descname"><span class="pre">handle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler_input</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">HandlerInput</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="headerlink" href="#app.NaviSonicRandomiseQueue.handle" title="Permalink to this definition"></a></dt>
<dd><p>Handles the Request inside handler input and provides a
Response for dispatcher to return.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>handler_input</strong> (<em>HandlerInput</em>) – Handler Input instance with
Request Envelope containing Request.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Response for the dispatcher to return or None</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Union[Response, None]</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="app.NaviSonicSongDetails">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">NaviSonicSongDetails</span></span><a class="headerlink" href="#app.NaviSonicSongDetails" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -2885,6 +2949,11 @@ <h3><a href="#">Table of Contents</a></h3>
<li><a class="reference internal" href="#app.NaviSonicPlaySongByArtist.handle"><code class="docutils literal notranslate"><span class="pre">NaviSonicPlaySongByArtist.handle()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#app.NaviSonicRandomiseQueue"><code class="docutils literal notranslate"><span class="pre">NaviSonicRandomiseQueue</span></code></a><ul>
<li><a class="reference internal" href="#app.NaviSonicRandomiseQueue.can_handle"><code class="docutils literal notranslate"><span class="pre">NaviSonicRandomiseQueue.can_handle()</span></code></a></li>
<li><a class="reference internal" href="#app.NaviSonicRandomiseQueue.handle"><code class="docutils literal notranslate"><span class="pre">NaviSonicRandomiseQueue.handle()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#app.NaviSonicSongDetails"><code class="docutils literal notranslate"><span class="pre">NaviSonicSongDetails</span></code></a><ul>
<li><a class="reference internal" href="#app.NaviSonicSongDetails.can_handle"><code class="docutils literal notranslate"><span class="pre">NaviSonicSongDetails.can_handle()</span></code></a></li>
<li><a class="reference internal" href="#app.NaviSonicSongDetails.handle"><code class="docutils literal notranslate"><span class="pre">NaviSonicSongDetails.handle()</span></code></a></li>
Expand Down
Binary file modified docs/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

Empty file removed sphinx/_build/.gitkeep
View file
Empty file.

0 comments on commit 001839e

Please sign in to comment.