Skip to content

Commit d4d237a

Browse files
lucascolleylucascolley
committed
Deploying to gh-pages from @ be06b63 🚀
1 parent a08b4cf commit d4d237a

13 files changed

+889
-12
lines changed

‎_sources/api-reference.md.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@
77
:toctree: generated
88

99
atleast_nd
10+
expand_dims
11+
kron
1012
```

‎_sources/generated/array_api_extra.expand_dims.rst.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
array\_api\_extra.expand\_dims
2+
==============================
3+
4+
.. currentmodule:: array_api_extra
5+
6+
.. autofunction:: expand_dims

‎_sources/generated/array_api_extra.kron.rst.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
array\_api\_extra.kron
2+
======================
3+
4+
.. currentmodule:: array_api_extra
5+
6+
.. autofunction:: kron

‎api-reference.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,8 @@
202202
<ul class="current">
203203
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
204204
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
205+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.expand_dims.html">array_api_extra.expand_dims</a></li>
206+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.kron.html">array_api_extra.kron</a></li>
205207
</ul>
206208
</li>
207209
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
@@ -257,6 +259,12 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
257259
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.atleast_nd.html#array_api_extra.atleast_nd" title="array_api_extra.atleast_nd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atleast_nd</span></code></a></p></td>
258260
<td><p>Recursively expand the dimension of an array to at least <cite>ndim</cite>.</p></td>
259261
</tr>
262+
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.expand_dims.html#array_api_extra.expand_dims" title="array_api_extra.expand_dims"><code class="xref py py-obj docutils literal notranslate"><span class="pre">expand_dims</span></code></a></p></td>
263+
<td><p>Expand the shape of an array.</p></td>
264+
</tr>
265+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.kron.html#array_api_extra.kron" title="array_api_extra.kron"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kron</span></code></a></p></td>
266+
<td><p>Kronecker product of two arrays.</p></td>
267+
</tr>
260268
</tbody>
261269
</table>
262270
</div>

‎contributing.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
6-
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="array_api_extra.atleast_nd" href="generated/array_api_extra.atleast_nd.html" />
6+
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="array_api_extra.kron" href="generated/array_api_extra.kron.html" />
77

88
<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
99
<title>Contributing - array-api-extra 0.1.2.dev0 documentation</title>
@@ -202,6 +202,8 @@
202202
<ul class="current">
203203
<li class="toctree-l1 has-children"><a class="reference internal" href="api-reference.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
204204
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
205+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.expand_dims.html">array_api_extra.expand_dims</a></li>
206+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.kron.html">array_api_extra.kron</a></li>
205207
</ul>
206208
</li>
207209
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Contributing</a></li>
@@ -341,14 +343,14 @@ <h2>Development workflow<a class="headerlink" href="#development-workflow" title
341343

342344
<div class="related-pages">
343345

344-
<a class="prev-page" href="generated/array_api_extra.atleast_nd.html">
346+
<a class="prev-page" href="generated/array_api_extra.kron.html">
345347
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
346348
<div class="page-info">
347349
<div class="context">
348350
<span>Previous</span>
349351
</div>
350352

351-
<div class="title">array_api_extra.atleast_nd</div>
353+
<div class="title">array_api_extra.kron</div>
352354

353355
</div>
354356
</a>

‎generated/array_api_extra.atleast_nd.html‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
6-
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Contributing" href="../contributing.html" /><link rel="prev" title="API Reference" href="../api-reference.html" />
6+
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="array_api_extra.expand_dims" href="array_api_extra.expand_dims.html" /><link rel="prev" title="API Reference" href="../api-reference.html" />
77

88
<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
99
<title>array_api_extra.atleast_nd - array-api-extra 0.1.2.dev0 documentation</title>
@@ -202,6 +202,8 @@
202202
<ul class="current">
203203
<li class="toctree-l1 current has-children"><a class="reference internal" href="../api-reference.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
204204
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">array_api_extra.atleast_nd</a></li>
205+
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.expand_dims.html">array_api_extra.expand_dims</a></li>
206+
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.kron.html">array_api_extra.kron</a></li>
205207
</ul>
206208
</li>
207209
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
@@ -253,13 +255,13 @@
253255
<h1>array_api_extra.atleast_nd<a class="headerlink" href="#array-api-extra-atleast-nd" title="Link to this heading"></a></h1>
254256
<dl class="py function">
255257
<dt class="sig sig-object py" id="array_api_extra.atleast_nd">
256-
<span class="sig-prename descclassname"><span class="pre">array_api_extra.</span></span><span class="sig-name descname"><span class="pre">atleast_nd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ndim</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#array_api_extra.atleast_nd" title="Link to this definition"></a></dt>
258+
<span class="sig-prename descclassname"><span class="pre">array_api_extra.</span></span><span class="sig-name descname"><span class="pre">atleast_nd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ndim</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#array_api_extra.atleast_nd" title="Link to this definition"></a></dt>
257259
<dd><p>Recursively expand the dimension of an array to at least <cite>ndim</cite>.</p>
258260
<dl class="field-list simple">
259261
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
260262
<dd class="field-odd"><ul class="simple">
261263
<li><p><strong>x</strong> (<em>array</em>)</p></li>
262-
<li><p><strong>ndim</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The minimum number of dimensions for the result.</p></li>
264+
<li><p><strong>ndim</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The minimum number of dimensions for the result.</p></li>
263265
<li><p><strong>xp</strong> (<em>array_namespace</em>) – The standard-compatible namespace for <cite>x</cite>.</p></li>
264266
</ul>
265267
</dd>
@@ -296,12 +298,12 @@ <h1>array_api_extra.atleast_nd<a class="headerlink" href="#array-api-extra-atlea
296298
<footer>
297299

298300
<div class="related-pages">
299-
<a class="next-page" href="../contributing.html">
301+
<a class="next-page" href="array_api_extra.expand_dims.html">
300302
<div class="page-info">
301303
<div class="context">
302304
<span>Next</span>
303305
</div>
304-
<div class="title">Contributing</div>
306+
<div class="title">array_api_extra.expand_dims</div>
305307
</div>
306308
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
307309
</a>

0 commit comments

Comments
 (0)