docs: Try to fix API docs for some modules

Seems like some pages related to storage aren't working, not sure why since it works locally. Trying to fix... Relates to #243
postlund · Sep 2, 2023 · 7498250 · 7498250
1 parent 856fede
commit 7498250
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/api/pyatv.html b/docs/api/pyatv.html
@@ -1,7 +1,7 @@
 ---
 layout: template
 title: API - pyatv
-permalink: /api/
+permalink: /api//
 link_group: api
 ---
 <nav id="sidebar">
@@ -101,7 +101,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </dd>
 <dt id="pyatv.scan">
 <code class="name flex">
-<span>async def <span class="ident">scan</span></span>(<span>loop: asyncio.events.AbstractEventLoop, timeout: int = 5, identifier: Union[str, Set[str], ForwardRef(None)] = None, protocol: Union[<a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a>, Set[<a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a>], ForwardRef(None)] = None, hosts: Optional[List[str]] = None, aiozc: Optional[zeroconf.asyncio.AsyncZeroconf] = None, storage: Optional[<a title="pyatv.interface.Storage" href="interface#pyatv.interface.Storage">Storage</a>] = None) -> List[<a title="pyatv.interface.BaseConfig" href="interface#pyatv.interface.BaseConfig">BaseConfig</a>]</span>
+<span>async def <span class="ident">scan</span></span>(<span>loop: asyncio.events.AbstractEventLoop, timeout: int = 5, identifier: Union[str, Set[str], None] = None, protocol: Union[<a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a>, Set[<a title="pyatv.const.Protocol" href="const#pyatv.const.Protocol">Protocol</a>], None] = None, hosts: Optional[List[str]] = None, aiozc: Optional[zeroconf.asyncio.AsyncZeroconf] = None, storage: Optional[<a title="pyatv.interface.Storage" href="interface#pyatv.interface.Storage">Storage</a>] = None) -> List[<a title="pyatv.interface.BaseConfig" href="interface#pyatv.interface.BaseConfig">BaseConfig</a>]</span>
 </code>
 </dt>
 <dd>

diff --git a/docs/api/pyatv/interface.html b/docs/api/pyatv/interface.html
@@ -1239,7 +1239,7 @@ <h3>Methods</h3>
 </code></dt>
 <dd>
 <section class="desc"><p>Container for media (e.g. audio or video) metadata.</p></section>
-<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/interface.py#L73-L82" class="git-link">Browse git</a></div>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/interface.py#L75-L82" class="git-link">Browse git</a></div>
 <h3>Class variables</h3>
 <dl>
 <dt id="pyatv.interface.MediaMetadata.album"><code class="name">var <span class="ident">album</span> -> Optional[str]</code></dt>

diff --git a/docs/api/pyatv/settings.html b/docs/api/pyatv/settings.html
@@ -216,7 +216,7 @@ <h3>Class variables</h3>
 <dd>
 <section class="desc"></section>
 </dd>
-<dt id="pyatv.settings.InfoSettings.mac"><code class="name">var <span class="ident">mac</span> -> str = 02:70:79:61:74:76</code></dt>
+<dt id="pyatv.settings.InfoSettings.mac"><code class="name">var <span class="ident">mac</span> -> typing_extensions.Annotated[str, AfterValidator(func=<function _mac_validator at 0x7f98603c9b80>)] = 02:70:79:61:74:76</code></dt>
 <dd>
 <section class="desc"></section>
 </dd>

diff --git a/docs/pdoc_templates/html.mako b/docs/pdoc_templates/html.mako
@@ -420,7 +420,7 @@
 ---
 layout: template
 title: API - ${module.name}
-permalink: /api/${module.name.replace("pyatv", "").replace(".", "/")}
+permalink: /api/${("/" + module.name).replace("pyatv", "").replace(".", "/").replace("//", "/")}
 link_group: api
 ---