Documentation update

This commit is contained in:
Ross Stewart
2022-08-27 13:36:57 +00:00
parent fcb5498cda
commit 8d40c752d0
36 changed files with 18091 additions and 0 deletions

277
docs/genindex.html Normal file
View File

@@ -0,0 +1,277 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; AskNavidrome 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/groundwork.css" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />
<link rel="stylesheet" href="../_static/css/functions.css" type="text/css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">AskNavidrome 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#B"><strong>B</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#H"><strong>H</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#Q"><strong>Q</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#U"><strong>U</strong></a>
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.controller.add_screen_background">add_screen_background() (in module asknavidrome.controller)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.add_track">add_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.albums_by_artist">albums_by_artist() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li>
asknavidrome.controller
<ul>
<li><a href="index.html#module-asknavidrome.controller">module</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.buffer">buffer (asknavidrome.media_queue.MediaQueue attribute)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.build_random_song_list">build_random_song_list() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.build_song_list_from_albums">build_song_list_from_albums() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.build_song_list_from_favourites">build_song_list_from_favourites() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.build_song_list_from_genre">build_song_list_from_genre() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.build_song_list_from_playlist">build_song_list_from_playlist() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.clear">clear() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.current_track">current_track (asknavidrome.media_queue.MediaQueue attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.enqueue_next_track">enqueue_next_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.controller.enqueue_songs">enqueue_songs() (in module asknavidrome.controller)</a>
</li>
</ul></td>
</tr></table>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_history_count">get_history_count() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_next_track">get_next_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_prevous_track">get_prevous_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_queue_count">get_queue_count() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.get_song_details">get_song_details() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.get_song_uri">get_song_uri() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.history">history (asknavidrome.media_queue.MediaQueue attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.logger">logger (asknavidrome.media_queue.MediaQueue attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue">MediaQueue (class in asknavidrome.media_queue)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
module
<ul>
<li><a href="index.html#module-asknavidrome.controller">asknavidrome.controller</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.ping">ping() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.queue">queue (asknavidrome.media_queue.MediaQueue attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_album">search_album() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_artist">search_artist() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_playlist">search_playlist() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_song">search_song() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.shuffle">shuffle() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.star_entry">star_entry() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.controller.start_playback">start_playback() (in module asknavidrome.controller)</a>
</li>
<li><a href="index.html#asknavidrome.controller.stop">stop() (in module asknavidrome.controller)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection">SubsonicConnection (class in asknavidrome.subsonic_api)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.sync">sync() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.track.Track">Track (class in asknavidrome.track)</a>
</li>
</ul></td>
</tr></table>
<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.unstar_entry">unstar_entry() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
</ul></td>
</tr></table>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">AskNavidrome 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2022, Ross Stewart.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.1.1.
</div>
</body>
</html>