docs: Another attempt to fix docs

Relates to #243
postlund · Sep 4, 2023 · d13ede5 · d13ede5
1 parent f0978ff
commit d13ede5
Show file tree

Hide file tree

Showing 13 changed files with 702 additions and 698 deletions.
diff --git a/docs/api/pyatv/conf.html → docs/api/pyatv.conf.html b/docs/api/pyatv/conf.html → docs/api/pyatv.conf.html
diff --git a/docs/api/pyatv/const.html → docs/api/pyatv.const.html b/docs/api/pyatv/const.html → docs/api/pyatv.const.html
diff --git a/docs/api/pyatv/convert.html → docs/api/pyatv.convert.html b/docs/api/pyatv/convert.html → docs/api/pyatv.convert.html
@@ -1,7 +1,7 @@
 ---
 layout: template
 title: API - pyatv.convert
-permalink: /api//convert
+permalink: /api/convert/
 link_group: api
 ---
 <nav id="sidebar">
@@ -12,17 +12,17 @@ <h1>Index</h1>
 <ul id="index">
 <li><h3>Super-module</h3>
 <ul>
-<li><code><a title="pyatv" href=".">pyatv</a></code></li>
+<li><code><a title="pyatv" href="../">pyatv</a></code></li>
 </ul>
 </li>
 <li><h3><a href="#header-functions">Functions</a></h3>
 <ul class="two-column">
-<li><code><a title="pyatv.convert.device_state_str" href="#pyatv.convert.device_state_str">device_state_str</a></code></li>
-<li><code><a title="pyatv.convert.media_type_str" href="#pyatv.convert.media_type_str">media_type_str</a></code></li>
-<li><code><a title="pyatv.convert.model_str" href="#pyatv.convert.model_str">model_str</a></code></li>
-<li><code><a title="pyatv.convert.protocol_str" href="#pyatv.convert.protocol_str">protocol_str</a></code></li>
-<li><code><a title="pyatv.convert.repeat_str" href="#pyatv.convert.repeat_str">repeat_str</a></code></li>
-<li><code><a title="pyatv.convert.shuffle_str" href="#pyatv.convert.shuffle_str">shuffle_str</a></code></li>
+<li><code><a title="pyatv.convert.device_state_str" href="#pyatv.convert.device_state_str/">device_state_str</a></code></li>
+<li><code><a title="pyatv.convert.media_type_str" href="#pyatv.convert.media_type_str/">media_type_str</a></code></li>
+<li><code><a title="pyatv.convert.model_str" href="#pyatv.convert.model_str/">model_str</a></code></li>
+<li><code><a title="pyatv.convert.protocol_str" href="#pyatv.convert.protocol_str/">protocol_str</a></code></li>
+<li><code><a title="pyatv.convert.repeat_str" href="#pyatv.convert.repeat_str/">repeat_str</a></code></li>
+<li><code><a title="pyatv.convert.shuffle_str" href="#pyatv.convert.shuffle_str/">shuffle_str</a></code></li>
 </ul>
 </li>
 </ul>
@@ -44,7 +44,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 <dl>
 <dt id="pyatv.convert.device_state_str">
 <code class="name flex">
-<span>def <span class="ident">device_state_str</span></span>(<span>state: <a title="pyatv.const.DeviceState" href="const#pyatv.const.DeviceState">DeviceState</a>) -> str</span>
+<span>def <span class="ident">device_state_str</span></span>(<span>state: <a title="pyatv.const.DeviceState" href="const#pyatv.const.DeviceState/">DeviceState</a>) -> str</span>
 </code>
 </dt>
 <dd>
@@ -53,7 +53,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </dd>
 <dt id="pyatv.convert.media_type_str">
 <code class="name flex">
-<span>def <span class="ident">media_type_str</span></span>(<span>mediatype: <a title="pyatv.const.MediaType" href="const#pyatv.const.MediaType">MediaType</a>) -> str</span>
+<span>def <span class="ident">media_type_str</span></span>(<span>mediatype: <a title="pyatv.const.MediaType" href="const#pyatv.const.MediaType/">MediaType</a>) -> str</span>
 </code>
 </dt>
 <dd>
@@ -62,7 +62,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </dd>
 <dt id="pyatv.convert.model_str">
 <code class="name flex">
-<span>def <span class="ident">model_str</span></span>(<span>device_model: <a title="pyatv.const.DeviceModel" href="const#pyatv.const.DeviceModel">DeviceModel</a>) -> str</span>
+<span>def <span class="ident">model_str</span></span>(<span>device_model: <a title="pyatv.const.DeviceModel" href="const#pyatv.const.DeviceModel/">DeviceModel</a>) -> str</span>
 </code>
 </dt>
 <dd>
@@ -71,7 +71,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </dd>
 <dt id="pyatv.convert.protocol_str">
 <code class="name flex">
-<span>def <span class="ident">protocol_str</span></span>(<span>protocol: <a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a>) -> str</span>
+<span>def <span class="ident">protocol_str</span></span>(<span>protocol: <a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol/">Protocol</a>) -> str</span>
 </code>
 </dt>
 <dd>
@@ -80,7 +80,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </dd>
 <dt id="pyatv.convert.repeat_str">
 <code class="name flex">
-<span>def <span class="ident">repeat_str</span></span>(<span>state: <a title="pyatv.const.RepeatState" href="const#pyatv.const.RepeatState">RepeatState</a>) -> str</span>
+<span>def <span class="ident">repeat_str</span></span>(<span>state: <a title="pyatv.const.RepeatState" href="const#pyatv.const.RepeatState/">RepeatState</a>) -> str</span>
 </code>
 </dt>
 <dd>
@@ -89,7 +89,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </dd>
 <dt id="pyatv.convert.shuffle_str">
 <code class="name flex">
-<span>def <span class="ident">shuffle_str</span></span>(<span>state: <a title="pyatv.const.ShuffleState" href="const#pyatv.const.ShuffleState">ShuffleState</a>) -> str</span>
+<span>def <span class="ident">shuffle_str</span></span>(<span>state: <a title="pyatv.const.ShuffleState" href="const#pyatv.const.ShuffleState/">ShuffleState</a>) -> str</span>
 </code>
 </dt>
 <dd>

diff --git a/docs/api/pyatv/exceptions.html → docs/api/pyatv.exceptions.html b/docs/api/pyatv/exceptions.html → docs/api/pyatv.exceptions.html
@@ -1,7 +1,7 @@
 ---
 layout: template
 title: API - pyatv.exceptions
-permalink: /api//exceptions
+permalink: /api/exceptions/
 link_group: api
 ---
 <nav id="sidebar">
@@ -12,91 +12,91 @@ <h1>Index</h1>
 <ul id="index">
 <li><h3>Super-module</h3>
 <ul>
-<li><code><a title="pyatv" href=".">pyatv</a></code></li>
+<li><code><a title="pyatv" href="../">pyatv</a></code></li>
 </ul>
 </li>
 <li><h3><a href="#header-classes">Classes</a></h3>
 <ul>
 <li>
-<h4><code><a title="pyatv.exceptions.AuthenticationError" href="#pyatv.exceptions.AuthenticationError">AuthenticationError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.AuthenticationError" href="#pyatv.exceptions.AuthenticationError/">AuthenticationError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.BackOffError" href="#pyatv.exceptions.BackOffError">BackOffError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.BackOffError" href="#pyatv.exceptions.BackOffError/">BackOffError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.BlockedStateError" href="#pyatv.exceptions.BlockedStateError">BlockedStateError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.BlockedStateError" href="#pyatv.exceptions.BlockedStateError/">BlockedStateError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.CommandError" href="#pyatv.exceptions.CommandError">CommandError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.CommandError" href="#pyatv.exceptions.CommandError/">CommandError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.ConnectionFailedError" href="#pyatv.exceptions.ConnectionFailedError">ConnectionFailedError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.ConnectionFailedError" href="#pyatv.exceptions.ConnectionFailedError/">ConnectionFailedError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.ConnectionLostError" href="#pyatv.exceptions.ConnectionLostError">ConnectionLostError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.ConnectionLostError" href="#pyatv.exceptions.ConnectionLostError/">ConnectionLostError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.DeviceIdMissingError" href="#pyatv.exceptions.DeviceIdMissingError">DeviceIdMissingError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.DeviceIdMissingError" href="#pyatv.exceptions.DeviceIdMissingError/">DeviceIdMissingError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.HttpError" href="#pyatv.exceptions.HttpError">HttpError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.HttpError" href="#pyatv.exceptions.HttpError/">HttpError</a></code></h4>
 <ul class="">
-<li><code><a title="pyatv.exceptions.HttpError.status_code" href="#pyatv.exceptions.HttpError.status_code">status_code</a></code></li>
+<li><code><a title="pyatv.exceptions.HttpError.status_code" href="#pyatv.exceptions.HttpError.status_code/">status_code</a></code></li>
 </ul>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.InvalidConfigError" href="#pyatv.exceptions.InvalidConfigError">InvalidConfigError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.InvalidConfigError" href="#pyatv.exceptions.InvalidConfigError/">InvalidConfigError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.InvalidCredentialsError" href="#pyatv.exceptions.InvalidCredentialsError">InvalidCredentialsError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.InvalidCredentialsError" href="#pyatv.exceptions.InvalidCredentialsError/">InvalidCredentialsError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.InvalidDmapDataError" href="#pyatv.exceptions.InvalidDmapDataError">InvalidDmapDataError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.InvalidDmapDataError" href="#pyatv.exceptions.InvalidDmapDataError/">InvalidDmapDataError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.InvalidResponseError" href="#pyatv.exceptions.InvalidResponseError">InvalidResponseError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.InvalidResponseError" href="#pyatv.exceptions.InvalidResponseError/">InvalidResponseError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.InvalidStateError" href="#pyatv.exceptions.InvalidStateError">InvalidStateError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.InvalidStateError" href="#pyatv.exceptions.InvalidStateError/">InvalidStateError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.NoAsyncListenerError" href="#pyatv.exceptions.NoAsyncListenerError">NoAsyncListenerError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.NoAsyncListenerError" href="#pyatv.exceptions.NoAsyncListenerError/">NoAsyncListenerError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.NoCredentialsError" href="#pyatv.exceptions.NoCredentialsError">NoCredentialsError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.NoCredentialsError" href="#pyatv.exceptions.NoCredentialsError/">NoCredentialsError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.NoServiceError" href="#pyatv.exceptions.NoServiceError">NoServiceError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.NoServiceError" href="#pyatv.exceptions.NoServiceError/">NoServiceError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.NonLocalSubnetError" href="#pyatv.exceptions.NonLocalSubnetError">NonLocalSubnetError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.NonLocalSubnetError" href="#pyatv.exceptions.NonLocalSubnetError/">NonLocalSubnetError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.NotSupportedError" href="#pyatv.exceptions.NotSupportedError">NotSupportedError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.NotSupportedError" href="#pyatv.exceptions.NotSupportedError/">NotSupportedError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.OperationTimeoutError" href="#pyatv.exceptions.OperationTimeoutError">OperationTimeoutError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.OperationTimeoutError" href="#pyatv.exceptions.OperationTimeoutError/">OperationTimeoutError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.PairingError" href="#pyatv.exceptions.PairingError">PairingError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.PairingError" href="#pyatv.exceptions.PairingError/">PairingError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.PlaybackError" href="#pyatv.exceptions.PlaybackError">PlaybackError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.PlaybackError" href="#pyatv.exceptions.PlaybackError/">PlaybackError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.ProtocolError" href="#pyatv.exceptions.ProtocolError">ProtocolError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.ProtocolError" href="#pyatv.exceptions.ProtocolError/">ProtocolError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.SettingsError" href="#pyatv.exceptions.SettingsError">SettingsError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.SettingsError" href="#pyatv.exceptions.SettingsError/">SettingsError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.UnknownMediaKindError" href="#pyatv.exceptions.UnknownMediaKindError">UnknownMediaKindError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.UnknownMediaKindError" href="#pyatv.exceptions.UnknownMediaKindError/">UnknownMediaKindError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.UnknownPlayStateError" href="#pyatv.exceptions.UnknownPlayStateError">UnknownPlayStateError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.UnknownPlayStateError" href="#pyatv.exceptions.UnknownPlayStateError/">UnknownPlayStateError</a></code></h4>
 </li>
 <li>
-<h4><code><a title="pyatv.exceptions.UnsupportedProtocolError" href="#pyatv.exceptions.UnsupportedProtocolError">UnsupportedProtocolError</a></code></h4>
+<h4><code><a title="pyatv.exceptions.UnsupportedProtocolError" href="#pyatv.exceptions.UnsupportedProtocolError/">UnsupportedProtocolError</a></code></h4>
 </li>
 </ul>
 </li>
@@ -152,7 +152,7 @@ <h3>Ancestors</h3>
 <dd>
 <section class="desc"><p>Thrown when calling a blocked method.</p>
 <p>Typically, public interface methods (e.g. any method available via the object
-returned by <code><a title="pyatv.connect" href="#pyatv.connect">connect()</a></code>) becomes blocked after either calling close or because
+returned by <code><a title="pyatv.connect" href="#pyatv.connect/">connect()</a></code>) becomes blocked after either calling close or because
 the connection was closed for some other reason.</p></section>
 <div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/exceptions.py#L113-L119" class="git-link">Browse git</a></div>
 <h3>Ancestors</h3>
@@ -223,7 +223,7 @@ <h3>Ancestors</h3>
 <div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/exceptions.py#L95-L106" class="git-link">Browse git</a></div>
 <h3>Ancestors</h3>
 <ul class="hlist">
-<li><a title="pyatv.exceptions.ProtocolError" href="#pyatv.exceptions.ProtocolError">ProtocolError</a></li>
+<li><a title="pyatv.exceptions.ProtocolError" href="#pyatv.exceptions.ProtocolError/">ProtocolError</a></li>
 <li>builtins.Exception</li>
 <li>builtins.BaseException</li>
 </ul>
@@ -425,7 +425,7 @@ <h3>Ancestors</h3>
 </ul>
 <h3>Subclasses</h3>
 <ul class="hlist">
-<li><a title="pyatv.exceptions.HttpError" href="#pyatv.exceptions.HttpError">HttpError</a></li>
+<li><a title="pyatv.exceptions.HttpError" href="#pyatv.exceptions.HttpError/">HttpError</a></li>
 </ul>
 </dd>
 <dt id="pyatv.exceptions.SettingsError"><code class="flex name class">

diff --git a/docs/api/pyatv/helpers.html → docs/api/pyatv.helpers.html b/docs/api/pyatv/helpers.html → docs/api/pyatv.helpers.html
@@ -1,7 +1,7 @@
 ---
 layout: template
 title: API - pyatv.helpers
-permalink: /api//helpers
+permalink: /api/helpers/
 link_group: api
 ---
 <nav id="sidebar">
@@ -12,15 +12,15 @@ <h1>Index</h1>
 <ul id="index">
 <li><h3>Super-module</h3>
 <ul>
-<li><code><a title="pyatv" href=".">pyatv</a></code></li>
+<li><code><a title="pyatv" href="../">pyatv</a></code></li>
 </ul>
 </li>
 <li><h3><a href="#header-functions">Functions</a></h3>
 <ul class="">
-<li><code><a title="pyatv.helpers.auto_connect" href="#pyatv.helpers.auto_connect">auto_connect</a></code></li>
-<li><code><a title="pyatv.helpers.get_unique_id" href="#pyatv.helpers.get_unique_id">get_unique_id</a></code></li>
-<li><code><a title="pyatv.helpers.is_device_supported" href="#pyatv.helpers.is_device_supported">is_device_supported</a></code></li>
-<li><code><a title="pyatv.helpers.is_streamable" href="#pyatv.helpers.is_streamable">is_streamable</a></code></li>
+<li><code><a title="pyatv.helpers.auto_connect" href="#pyatv.helpers.auto_connect/">auto_connect</a></code></li>
+<li><code><a title="pyatv.helpers.get_unique_id" href="#pyatv.helpers.get_unique_id/">get_unique_id</a></code></li>
+<li><code><a title="pyatv.helpers.is_device_supported" href="#pyatv.helpers.is_device_supported/">is_device_supported</a></code></li>
+<li><code><a title="pyatv.helpers.is_streamable" href="#pyatv.helpers.is_streamable/">is_streamable</a></code></li>
 </ul>
 </li>
 </ul>
@@ -42,7 +42,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 <dl>
 <dt id="pyatv.helpers.auto_connect">
 <code class="name flex">
-<span>async def <span class="ident">auto_connect</span></span>(<span>handler: Callable[[<a title="pyatv.interface.AppleTV" href="interface#pyatv.interface.AppleTV">AppleTV</a>], None], timeout: int = 5, not_found: Optional[Callable[[], None]] = None, loop: Optional[asyncio.events.AbstractEventLoop] = None) -> None</span>
+<span>async def <span class="ident">auto_connect</span></span>(<span>handler: Callable[[<a title="pyatv.interface.AppleTV" href="interface#pyatv.interface.AppleTV/">AppleTV</a>], None], timeout: int = 5, not_found: Optional[Callable[[], None]] = None, loop: Optional[asyncio.events.AbstractEventLoop] = None) -> None</span>
 </code>
 </dt>
 <dd>
@@ -69,7 +69,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </dd>
 <dt id="pyatv.helpers.is_device_supported">
 <code class="name flex">
-<span>def <span class="ident">is_device_supported</span></span>(<span>conf: <a title="pyatv.interface.BaseConfig" href="interface#pyatv.interface.BaseConfig">BaseConfig</a>) -> bool</span>
+<span>def <span class="ident">is_device_supported</span></span>(<span>conf: <a title="pyatv.interface.BaseConfig" href="interface#pyatv.interface.BaseConfig/">BaseConfig</a>) -> bool</span>
 </code>
 </dt>
 <dd>