Deploying to gh-pages from @ 83897e5 🚀

Author: lucascolley

_sources/contributing.md.txt

@@ -61,7 +61,7 @@ development of array-api-extra is made easy with
   at <https://github.com/data-apis/array-api-extra>.
 - `cd array-api-extra`.
 - [Install Pixi](https://pixi.sh/latest/#installation).
-- To enter a development environment:
+- To enter a development environment (if you prefer this to the `pixi run` interface):
 
 ```
 pixi shell -e dev
@@ -73,71 +73,75 @@ pixi shell -e dev
 pixi run tests
 ```
 
-- To generate the coverage report:
+- To build the docs locally:
 
 ```
-pixi run coverage
+pixi run docs
 ```
 
-- To generate and display the coverage report:
+- To build and preview the docs locally:
 
 ```
-pixi run open-coverage
+pixi run open-docs
 ```
 
-- To build the docs locally:
+- To install pre-commit hooks:
 
 ```
-pixi run docs
+pixi run hooks
 ```
 
-- To build and preview the docs locally:
+- To run pre-commit checks on staged files:
 
 ```
-pixi run open-docs
+pixi run pre-commit
 ```
 
-- To install a [pre-commit](https://pre-commit.com) hook:
+- To run the full lint suite:
 
 ```
-pixi run pre-commit-install
+pixi run --environment=lint lint
 ```
 
-- To run the lint suite:
+- To enter an interactive Python prompt:
 
 ```
-pixi run -e lint lint
+pixi run ipython
 ```
 
-- To enter an interactive Python prompt:
+- To run individual parts of the lint suite separately (for example):
 
 ```
-pixi run ipython
+pixi run --environment=lint pyright
+pixi run --environment=lint dprint
+```
+
+- To generate the coverage report:
+
+```
+pixi run coverage
 ```
 
-- To run individual parts of the lint suite separately:
+- To generate and display the coverage report:
 
 ```
-pixi run -e lint pre-commit
-pixi run -e lint pylint
-pixi run -e lint mypy
-pixi run -e lint pyright
+pixi run open-coverage
 ```
 
 Alternative environments are available with a subset of the dependencies and
 tasks available in the `dev` environment:
 
 ```
-pixi shell -e docs
-pixi shell -e tests
-pixi shell -e tests-backends
-pixi shell -e lint
+pixi shell --environment=docs
+pixi shell --environment=tests
+pixi shell --environment=tests-backends
+pixi shell --environment=lint
 ```
 
 If you run on a host with CUDA hardware, you can enable extra tests:
 
 ```
-pixi shell -e dev-cuda
-pixi shell -e tests-cuda
-pixi run -e tests-cuda tests
+pixi shell --environment=dev-cuda
+pixi shell --environment=tests-cuda
+pixi run --environment=tests-cuda tests
 ```

_sources/contributors.md.txt

@@ -1,3 +1,2 @@
 ```{include} ../CONTRIBUTORS.md
-
 ```

_sources/index.md.txt

@@ -17,7 +17,7 @@ well as delegation to existing implementations for known array library backends.
 The intended users of this library are "array-consuming" libraries which are
 using [array-api-compat](https://data-apis.org/array-api-compat/) to make their
 own library's functions array-agnostic. In this library, they will find a set of
-tools which provide _extra_ functionality on top of the array API standard,
+tools which provide *extra* functionality on top of the array API standard,
 which other array-consuming libraries in a similar position have found useful
 themselves.
 
@@ -27,7 +27,7 @@ It is currently used by:
   scientific computing.
 - [scikit-learn](https://github.com/scikit-learn/scikit-learn) — Machine
   Learning in Python.
-- _your library? Let us know!_
+- *your library? Let us know!*
 
 (installation)=
 
@@ -114,8 +114,7 @@ def array_namespace(*xs, **kwargs):
 See [an example of this in SciPy][scipy-vendor-example].
 ```
 
-[scipy-vendor-example]:
-  https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py
+[scipy-vendor-example]: https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py
 
 ## Versioning
 

contributing.html

@@ -336,7 +336,7 @@ <h2>Development workflow<a class="headerlink" href="#development-workflow" title
 at <a class="reference external" href="https://github.com/data-apis/array-api-extra">https://github.com/data-apis/array-api-extra</a>.</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">array-api-extra</span></code>.</p></li>
 <li><p><a class="reference external" href="https://pixi.sh/latest/#installation">Install Pixi</a>.</p></li>
-<li><p>To enter a development environment:</p></li>
+<li><p>To enter a development environment (if you prefer this to the <code class="docutils literal notranslate"><span class="pre">pixi</span> <span class="pre">run</span></code> interface):</p></li>
 </ul>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">shell</span> <span class="o">-</span><span class="n">e</span> <span class="n">dev</span>
 </pre></div>
@@ -348,68 +348,72 @@ <h2>Development workflow<a class="headerlink" href="#development-workflow" title
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>To generate the coverage report:</p></li>
+<li><p>To build the docs locally:</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">coverage</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">docs</span>
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>To generate and display the coverage report:</p></li>
+<li><p>To build and preview the docs locally:</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="nb">open</span><span class="o">-</span><span class="n">coverage</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="nb">open</span><span class="o">-</span><span class="n">docs</span>
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>To build the docs locally:</p></li>
+<li><p>To install pre-commit hooks:</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">docs</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">hooks</span>
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>To build and preview the docs locally:</p></li>
+<li><p>To run pre-commit checks on staged files:</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="nb">open</span><span class="o">-</span><span class="n">docs</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">pre</span><span class="o">-</span><span class="n">commit</span>
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>To install a <a class="reference external" href="https://pre-commit.com">pre-commit</a> hook:</p></li>
+<li><p>To run the full lint suite:</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">pre</span><span class="o">-</span><span class="n">commit</span><span class="o">-</span><span class="n">install</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">lint</span> <span class="n">lint</span>
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>To run the lint suite:</p></li>
+<li><p>To enter an interactive Python prompt:</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="o">-</span><span class="n">e</span> <span class="n">lint</span> <span class="n">lint</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">ipython</span>
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>To enter an interactive Python prompt:</p></li>
+<li><p>To run individual parts of the lint suite separately (for example):</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">ipython</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">lint</span> <span class="n">pyright</span>
+<span class="n">pixi</span> <span class="n">run</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">lint</span> <span class="n">dprint</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><p>To generate the coverage report:</p></li>
+</ul>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="n">coverage</span>
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>To run individual parts of the lint suite separately:</p></li>
+<li><p>To generate and display the coverage report:</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="o">-</span><span class="n">e</span> <span class="n">lint</span> <span class="n">pre</span><span class="o">-</span><span class="n">commit</span>
-<span class="n">pixi</span> <span class="n">run</span> <span class="o">-</span><span class="n">e</span> <span class="n">lint</span> <span class="n">pylint</span>
-<span class="n">pixi</span> <span class="n">run</span> <span class="o">-</span><span class="n">e</span> <span class="n">lint</span> <span class="n">mypy</span>
-<span class="n">pixi</span> <span class="n">run</span> <span class="o">-</span><span class="n">e</span> <span class="n">lint</span> <span class="n">pyright</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">run</span> <span class="nb">open</span><span class="o">-</span><span class="n">coverage</span>
 </pre></div>
 </div>
 <p>Alternative environments are available with a subset of the dependencies and
 tasks available in the <code class="docutils literal notranslate"><span class="pre">dev</span></code> environment:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">shell</span> <span class="o">-</span><span class="n">e</span> <span class="n">docs</span>
-<span class="n">pixi</span> <span class="n">shell</span> <span class="o">-</span><span class="n">e</span> <span class="n">tests</span>
-<span class="n">pixi</span> <span class="n">shell</span> <span class="o">-</span><span class="n">e</span> <span class="n">tests</span><span class="o">-</span><span class="n">backends</span>
-<span class="n">pixi</span> <span class="n">shell</span> <span class="o">-</span><span class="n">e</span> <span class="n">lint</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">shell</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">docs</span>
+<span class="n">pixi</span> <span class="n">shell</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">tests</span>
+<span class="n">pixi</span> <span class="n">shell</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">tests</span><span class="o">-</span><span class="n">backends</span>
+<span class="n">pixi</span> <span class="n">shell</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">lint</span>
 </pre></div>
 </div>
 <p>If you run on a host with CUDA hardware, you can enable extra tests:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">shell</span> <span class="o">-</span><span class="n">e</span> <span class="n">dev</span><span class="o">-</span><span class="n">cuda</span>
-<span class="n">pixi</span> <span class="n">shell</span> <span class="o">-</span><span class="n">e</span> <span class="n">tests</span><span class="o">-</span><span class="n">cuda</span>
-<span class="n">pixi</span> <span class="n">run</span> <span class="o">-</span><span class="n">e</span> <span class="n">tests</span><span class="o">-</span><span class="n">cuda</span> <span class="n">tests</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pixi</span> <span class="n">shell</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">dev</span><span class="o">-</span><span class="n">cuda</span>
+<span class="n">pixi</span> <span class="n">shell</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">tests</span><span class="o">-</span><span class="n">cuda</span>
+<span class="n">pixi</span> <span class="n">run</span> <span class="o">--</span><span class="n">environment</span><span class="o">=</span><span class="n">tests</span><span class="o">-</span><span class="n">cuda</span> <span class="n">tests</span>
 </pre></div>
 </div>
 </section>