CI: Update docs for 0.11.1 (2a66eb2)

pdoc3 · Jun 26, 2024 · c220311 · c220311
1 parent 56cb13e
commit c220311
Show file tree

Hide file tree

Showing 10 changed files with 240 additions and 82 deletions.
diff --git a/doc/pdoc/cli.html b/doc/pdoc/cli.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.0">
+<meta name="generator" content="pdoc3 0.11.1">
 <title>pdoc.cli API documentation</title>
 <meta name="description" content="pdoc&#39;s CLI interface and helper functions.">
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
@@ -97,7 +97,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </main>
 <footer id="footer">
 <p><span style="color:#ddd">&#21328;</span></p>
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.0</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/doc/pdoc/html_helpers.html b/doc/pdoc/html_helpers.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.0">
+<meta name="generator" content="pdoc3 0.11.1">
 <title>pdoc.html_helpers API documentation</title>
 <meta name="description" content="Helper functions for HTML output.">
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
@@ -116,7 +116,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/html_helpers.py#L493-L499" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/html_helpers.py#L493-L499" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class ReferenceWarning(UserWarning):
     &#34;&#34;&#34;
@@ -179,7 +179,7 @@ <h4><code><a title="pdoc.html_helpers.ReferenceWarning" href="#pdoc.html_helpers
 </main>
 <footer id="footer">
 <p><span style="color:#ddd">&#21328;</span></p>
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.0</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/doc/pdoc/index.html b/doc/pdoc/index.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.0">
+<meta name="generator" content="pdoc3 0.11.1">
 <title>pdoc API documentation</title>
 <meta name="description" content="Python package `pdoc` provides types, functions, and a command-line
 interface for accessing public documentation of Python modules, and
@@ -415,7 +415,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/__init__.py#L1021-L1270" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/__init__.py#L1021-L1270" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class Class(Doc):
     &#34;&#34;&#34;
@@ -775,7 +775,7 @@ <h3>Inherited members</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/__init__.py#L70-L89" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/__init__.py#L70-L89" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class Context(dict):
     &#34;&#34;&#34;
@@ -827,7 +827,7 @@ <h3>Ancestors</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/__init__.py#L485-L621" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/__init__.py#L485-L621" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class Doc:
     &#34;&#34;&#34;
@@ -1092,7 +1092,7 @@ <h3>Methods</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/__init__.py#L1651-L1686" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/__init__.py#L1651-L1686" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class External(Doc):
     &#34;&#34;&#34;
@@ -1175,7 +1175,7 @@ <h3>Inherited members</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/__init__.py#L1329-L1598" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/__init__.py#L1329-L1598" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class Function(Doc):
     &#34;&#34;&#34;
@@ -1543,7 +1543,7 @@ <h3>Inherited members</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/__init__.py#L624-L990" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/__init__.py#L624-L990" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class Module(Doc):
     &#34;&#34;&#34;
@@ -2059,7 +2059,7 @@ <h3>Inherited members</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/__init__.py#L1601-L1648" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/__init__.py#L1601-L1648" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class Variable(Doc):
     &#34;&#34;&#34;
@@ -2298,7 +2298,7 @@ <h4><code><a title="pdoc.Variable" href="#pdoc.Variable">Variable</a></code></h4
 </main>
 <footer id="footer">
 <p><span style="color:#ddd">&#21328;</span></p>
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.0</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/doc/pdoc/test/example_pkg/index.html b/doc/pdoc/test/example_pkg/index.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.0">
+<meta name="generator" content="pdoc3 0.11.1">
 <title>pdoc.test.example_pkg API documentation</title>
 <meta name="description" content="Module docstring">
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
@@ -136,6 +136,8 @@ <h2 id="args_1">Args</h2>
 <dd>Description of arg1</dd>
 <dt><strong><code>arg2</code></strong> :&ensp;<code>str</code> or <code>int</code></dt>
 <dd>Description of arg2</dd>
+<dt><strong><code>arg3</code></strong> :&ensp;<code>str | None</code></dt>
+<dd>Description of arg3</dd>
 <dt><strong><code>test_sequence</code></strong></dt>
 <dd>
 <p>2-dim numpy array of real numbers, size: N * D
@@ -163,6 +165,11 @@ <h2 id="returns_2">Returns</h2>
 <dt><code>Dict[int, <a title="pdoc.Doc" href="../../index.html#pdoc.Doc">Doc</a>]</code></dt>
 <dd>Description.</dd>
 </dl>
+<h2 id="returns_3">Returns</h2>
+<dl>
+<dt><code>int | str</code></dt>
+<dd>Description.</dd>
+</dl>
 <h2 id="raises">Raises</h2>
 <dl>
 <dt><code>AttributeError</code></dt>
@@ -200,6 +207,12 @@ <h2 id="todos">Todos</h2>
 <p>Escaping \$ should work in math like $X = \$3.25$ once it is implemented.</p>
 <p>[ v_t <em>\frac{1}{2}</em> j_i + [a] &lt; 3 ]</p></div>
 </dd>
+<dt id="pdoc.test.example_pkg.non_callable_routine"><code class="name flex">
+<span>def <span class="ident">non_callable_routine</span></span>(<span>x)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="pdoc.test.example_pkg.numpy"><code class="name flex">
 <span>def <span class="ident">numpy</span></span>(<span>self)</span>
 </code></dt>
@@ -331,7 +344,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/test/example_pkg/__init__.py#L32-L44" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/test/example_pkg/__init__.py#L32-L44" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class A:
     &#34;&#34;&#34;`A` is base class for `example_pkg.B`.&#34;&#34;&#34;  # Test refname link
@@ -384,7 +397,7 @@ <h3>Methods</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/test/example_pkg/__init__.py#L59-L129" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/test/example_pkg/__init__.py#L59-L129" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class B(A, int):
     &#34;&#34;&#34;
@@ -579,7 +592,7 @@ <h3>Inherited members</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/test/example_pkg/__init__.py#L132-L132" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/test/example_pkg/__init__.py#L132-L132" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class C(B): pass  # noqa: E701, E302</code></pre>
 </details>
@@ -625,7 +638,7 @@ <h3>Inherited members</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/test/example_pkg/__init__.py#L133-L133" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/test/example_pkg/__init__.py#L133-L133" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class D(C): pass  # noqa: E701, E302</code></pre>
 </details>
@@ -665,7 +678,7 @@ <h3>Inherited members</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/test/example_pkg/__init__.py#L140-L337" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/test/example_pkg/__init__.py#L140-L341" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class Docformats:
     def numpy(self):
@@ -753,6 +766,7 @@ <h3>Inherited members</h3>
         Args:
           arg1 (int): Description of arg1
           arg2 (str or int): Description of arg2
+          arg3 (str | None): Description of arg3
           test_sequence: 2-dim numpy array of real numbers, size: N * D
             - the test observation sequence.
 
@@ -774,6 +788,9 @@ <h3>Inherited members</h3>
         Returns:
             Dict[int, pdoc.Doc]: Description.
 
+        Returns:
+            int | str: Description.
+
         Raises:
             AttributeError: The ``Raises`` section is a list of all exceptions
                 that are relevant to the interface.
@@ -921,6 +938,8 @@ <h2 id="args_1">Args</h2>
 <dd>Description of arg1</dd>
 <dt><strong><code>arg2</code></strong> :&ensp;<code>str</code> or <code>int</code></dt>
 <dd>Description of arg2</dd>
+<dt><strong><code>arg3</code></strong> :&ensp;<code>str | None</code></dt>
+<dd>Description of arg3</dd>
 <dt><strong><code>test_sequence</code></strong></dt>
 <dd>
 <p>2-dim numpy array of real numbers, size: N * D
@@ -948,6 +967,11 @@ <h2 id="returns_2">Returns</h2>
 <dt><code>Dict[int, <a title="pdoc.Doc" href="../../index.html#pdoc.Doc">Doc</a>]</code></dt>
 <dd>Description.</dd>
 </dl>
+<h2 id="returns_3">Returns</h2>
+<dl>
+<dt><code>int | str</code></dt>
+<dd>Description.</dd>
+</dl>
 <h2 id="raises">Raises</h2>
 <dl>
 <dt><code>AttributeError</code></dt>
@@ -1096,7 +1120,7 @@ <h3 id="h3-title">H3 Title</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/test/example_pkg/__init__.py#L379-L385" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/test/example_pkg/__init__.py#L383-L389" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class HasMockAttributes:
     &#34;&#34;&#34;
@@ -1127,7 +1151,7 @@ <h3>Class variables</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/test/example_pkg/__init__.py#L369-L370" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/test/example_pkg/__init__.py#L373-L374" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">class Location(namedtuple(&#39;Location&#39;, &#39;lat lon&#39;)):
     &#34;&#34;&#34;Geo-location, GPS position.&#34;&#34;&#34;</code></pre>
@@ -1145,7 +1169,7 @@ <h3>Ancestors</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/pdoc3/pdoc/blob/84ee28b60f6aebdfe28f2a6a352991370fb5b81a/pdoc/test/example_pkg/__init__.py#L50-L56" class="git-link">Browse git</a>
+<a href="https://github.com/pdoc3/pdoc/blob/2a66eb2c882cabd195a61f44a921bfdc39eddf2e/pdoc/test/example_pkg/__init__.py#L50-L56" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">def __get__(self, instance, instance_type=None):
     if instance is not None:
@@ -1196,6 +1220,7 @@ <h3>Ancestors</h3>
 <li><code><a title="pdoc.test.example_pkg.foo" href="#pdoc.test.example_pkg.foo">foo</a></code></li>
 <li><code><a title="pdoc.test.example_pkg.google" href="#pdoc.test.example_pkg.google">google</a></code></li>
 <li><code><a title="pdoc.test.example_pkg.latex_math" href="#pdoc.test.example_pkg.latex_math">latex_math</a></code></li>
+<li><code><a title="pdoc.test.example_pkg.non_callable_routine" href="#pdoc.test.example_pkg.non_callable_routine">non_callable_routine</a></code></li>
 <li><code><a title="pdoc.test.example_pkg.numpy" href="#pdoc.test.example_pkg.numpy">numpy</a></code></li>
 <li><code><a title="pdoc.test.example_pkg.object_as_arg_default" href="#pdoc.test.example_pkg.object_as_arg_default">object_as_arg_default</a></code></li>
 <li><code><a title="pdoc.test.example_pkg.reST_directives" href="#pdoc.test.example_pkg.reST_directives">reST_directives</a></code></li>
@@ -1262,7 +1287,7 @@ <h4><code><a title="pdoc.test.example_pkg.ReadOnlyValueDescriptor" href="#pdoc.t
 </main>
 <footer id="footer">
 <p><span style="color:#ddd">&#21328;</span></p>
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.0</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
 </footer>
 </body>
 </html>