docs: Various minor updates

CONTRIBUTORS.md

@@ -1,9 +1,3 @@
 # Contributors
 
-Pierre Ståhl
-
-Pierrick Rouxel
-
-Rob Nee
-
-Robbie Trencheny
+See [this page](https://pyatv.dev/support/acknowledgements/#contributors)

README.md

@@ -22,8 +22,3 @@ To save you some time, here are some shortcuts:
 * [Development](https://pyatv.dev/development)
 * [API Reference](https://pyatv.dev/api)
 * [Support](https://pyatv.dev/support)
-
-# Why is the README so short?
-
-As much information as possible is available via GitHub pages in order to minimize the amount
-of duplicated information. That is why.

docs/_config.yml

@@ -75,6 +75,8 @@ page_links:
       title: Troubleshooting
     - link: /support/faq/
       title: FAQ
+    - link: /support/acknowledgements/
+      title: Acknowledgements
 
 exclude:
   - Gemfile

docs/api/pyatv.html

@@ -404,7 +404,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <h2 class="section-title" id="header-functions">Functions</h2>
 <dl>
 <dt id="pyatv.connect"><code class="name flex">
-<span>async def <span class="ident">connect</span></span>(<span>config, loop, protocol=None, session=None)</span>
+<span>async def <span class="ident">connect</span></span>(<span>config: <a title="pyatv.conf.AppleTV" href="conf#pyatv.conf.AppleTV">AppleTV</a>, loop: asyncio.events.AbstractEventLoop, protocol: <a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a> = None, session: aiohttp.client.ClientSession = None) -> <a title="pyatv.interface.AppleTV" href="interface#pyatv.interface.AppleTV">AppleTV</a></span>
 </code></dt>
 <dd>
 <section class="desc"><p>Connect to a device based on a configuration.</p></section>
@@ -444,7 +444,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </details>
 </dd>
 <dt id="pyatv.pair"><code class="name flex">
-<span>async def <span class="ident">pair</span></span>(<span>config, protocol, loop, session=None, **kwargs)</span>
+<span>async def <span class="ident">pair</span></span>(<span>config: <a title="pyatv.conf.AppleTV" href="conf#pyatv.conf.AppleTV">AppleTV</a>, protocol: <a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a>, loop: asyncio.events.AbstractEventLoop, session: aiohttp.client.ClientSession = None, **kwargs)</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Pair a protocol for an Apple TV.</p></section>
@@ -482,7 +482,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </details>
 </dd>
 <dt id="pyatv.scan"><code class="name flex">
-<span>async def <span class="ident">scan</span></span>(<span>loop, timeout=5, identifier=None, protocol=None, hosts=None)</span>
+<span>async def <span class="ident">scan</span></span>(<span>loop: asyncio.events.AbstractEventLoop, timeout: int = 5, identifier: str = None, protocol: <a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a> = None, hosts: List[str] = None) -> List[<a title="pyatv.conf.AppleTV" href="conf#pyatv.conf.AppleTV">AppleTV</a>]</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Scan for Apple TVs on network and return their configurations.</p></section>

docs/api/pyatv/conf.html

@@ -274,7 +274,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="pyatv.conf.AirPlayService"><code class="flex name class">
 <span>class <span class="ident">AirPlayService</span></span>
-<span>(</span><span>identifier, port=7000, credentials=None, properties=None)</span>
+<span>(</span><span>identifier: str, port: int = 7000, credentials: str = None, properties: Union[Dict[str, str], NoneType] = None)</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Representation of an AirPlay service.</p>
@@ -313,7 +313,7 @@ <h3>Inherited members</h3>
 </dd>
 <dt id="pyatv.conf.AppleTV"><code class="flex name class">
 <span>class <span class="ident">AppleTV</span></span>
-<span>(</span><span>address, name)</span>
+<span>(</span><span>address: ipaddress.IPv4Address, name: str)</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Representation of an Apple TV configuration.</p>
@@ -556,7 +556,7 @@ <h3>Instance variables</h3>
 <h3>Methods</h3>
 <dl>
 <dt id="pyatv.conf.AppleTV.add_service"><code class="name flex">
-<span>def <span class="ident">add_service</span></span>(<span>self, service)</span>
+<span>def <span class="ident">add_service</span></span>(<span>self, service: <a title="pyatv.interface.BaseService" href="interface#pyatv.interface.BaseService">BaseService</a>) -> NoneType</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Add a new service.</p>
@@ -578,7 +578,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="pyatv.conf.AppleTV.get_service"><code class="name flex">
-<span>def <span class="ident">get_service</span></span>(<span>self, protocol)</span>
+<span>def <span class="ident">get_service</span></span>(<span>self, protocol: <a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a>) -> Union[<a title="pyatv.interface.BaseService" href="interface#pyatv.interface.BaseService">BaseService</a>, NoneType]</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Look up a service based on protocol.</p>
@@ -598,7 +598,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="pyatv.conf.AppleTV.main_service"><code class="name flex">
-<span>def <span class="ident">main_service</span></span>(<span>self, protocol=None)</span>
+<span>def <span class="ident">main_service</span></span>(<span>self, protocol: <a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a> = None) -> <a title="pyatv.interface.BaseService" href="interface#pyatv.interface.BaseService">BaseService</a></span>
 </code></dt>
 <dd>
 <section class="desc"><p>Return suggested service used to establish connection.</p></section>
@@ -621,7 +621,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="pyatv.conf.AppleTV.set_credentials"><code class="name flex">
-<span>def <span class="ident">set_credentials</span></span>(<span>self, protocol, credentials)</span>
+<span>def <span class="ident">set_credentials</span></span>(<span>self, protocol: <a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a>, credentials: str) -> bool</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Set credentials for a protocol if it exists.</p></section>
@@ -642,7 +642,7 @@ <h3>Methods</h3>
 </dd>
 <dt id="pyatv.conf.DmapService"><code class="flex name class">
 <span>class <span class="ident">DmapService</span></span>
-<span>(</span><span>identifier, credentials, port=None, properties=None)</span>
+<span>(</span><span>identifier: str, credentials: str, port: int = None, properties: Union[Dict[str, str], NoneType] = None)</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Representation of a DMAP service.</p>
@@ -681,7 +681,7 @@ <h3>Inherited members</h3>
 </dd>
 <dt id="pyatv.conf.MrpService"><code class="flex name class">
 <span>class <span class="ident">MrpService</span></span>
-<span>(</span><span>identifier, port, credentials=None, properties=None)</span>
+<span>(</span><span>identifier: str, port: int, credentials: str = None, properties: Union[Dict[str, str], NoneType] = None)</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Representation of a MediaRemote Protocol (MRP) service.</p>

docs/api/pyatv/convert.html

@@ -99,7 +99,7 @@ <h1 class="title">Module <code>pyatv.convert</code></h1>
 <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)</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>
 <section class="desc"><p>Convert internal API device state to string.</p></section>
@@ -121,7 +121,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </details>
 </dd>
 <dt id="pyatv.convert.media_type_str"><code class="name flex">
-<span>def <span class="ident">media_type_str</span></span>(<span>mediatype)</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>
 <section class="desc"><p>Convert internal API media type to string.</p></section>
@@ -140,7 +140,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </details>
 </dd>
 <dt id="pyatv.convert.protocol_str"><code class="name flex">
-<span>def <span class="ident">protocol_str</span></span>(<span>protocol)</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>
 <section class="desc"><p>Convert internal API protocol to string.</p></section>
@@ -158,7 +158,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </details>
 </dd>
 <dt id="pyatv.convert.repeat_str"><code class="name flex">
-<span>def <span class="ident">repeat_str</span></span>(<span>state)</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>
 <section class="desc"><p>Convert internal API repeat state to string.</p></section>
@@ -176,7 +176,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </details>
 </dd>
 <dt id="pyatv.convert.shuffle_str"><code class="name flex">
-<span>def <span class="ident">shuffle_str</span></span>(<span>state)</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>
 <section class="desc"><p>Convert internal API shuffle state to string.</p></section>

docs/api/pyatv/helpers.html

@@ -83,7 +83,7 @@ <h1 class="title">Module <code>pyatv.helpers</code></h1>
 <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, timeout=5, not_found=None, loop=None)</span>
+<span>async def <span class="ident">auto_connect</span></span>(<span>handler: Callable[[pyatv.interface.AppleTV], NoneType], timeout: int = 5, not_found: Callable[[], NoneType] = None, loop: Union[asyncio.events.AbstractEventLoop, NoneType] = None) -> NoneType</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Connect to first discovered device.</p>