Skip to content

Commit 263ce4f

Browse files
Deployed 7dbdddf to dev with MkDocs 1.6.1 and mike 2.0.0
1 parent 85d39d6 commit 263ce4f

File tree

40 files changed

+202
-204
lines changed

40 files changed

+202
-204
lines changed

dev/Community/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -2164,7 +2164,7 @@
21642164

21652165

21662166
<h1 id="community">Community<a class="headerlink" href="#community" title="Permanent link">#</a></h1>
2167-
<p>When you want to show your users and contributors that they can use pixi in your repo, you can use the following badge:</p>
2167+
<p>When you want to show your users and contributors that they can use Pixi in your repo, you can use the following badge:</p>
21682168
<p><a href="https://pixi.sh"><img alt="Pixi Badge" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json" /></a></p>
21692169
<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>[![Pixi Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json)](https://pixi.sh)
21702170
</span></code></pre></div>
@@ -2217,7 +2217,7 @@ <h2 id="built-using-pixi">Built using Pixi<a class="headerlink" href="#built-usi
22172217
</ul>
22182218
<ul>
22192219
<li><a href="https://github.com/pavelzw/pixi-pycharm">pixi-pycharm</a>: Conda shim for PyCharm that proxies pixi</li>
2220-
<li><a href="https://github.com/pavelzw/pixi-diff-to-markdown">pixi-diff-to-markdown</a>: Generate markdown summaries from pixi update</li>
2220+
<li><a href="https://github.com/pavelzw/pixi-diff-to-markdown">pixi-diff-to-markdown</a>: Generate markdown summaries from Pixi update</li>
22212221
<li><a href="https://github.com/jiaxiyang/cpp_project_guideline">jiaxiyang/cpp_project_guideline</a>: Guide the way beginners make their c++ projects.</li>
22222222
<li><a href="https://github.com/hex-inc/vegafusion">hex-inc/vegafusion</a>: Serverside scaling of Vega and Altair visualizations in Rust, Python, WASM, and Java</li>
22232223
<li><a href="https://github.com/pablovela5620/arxiv-researcher">pablovela5620/arxiv-researcher</a>: Summarize PDF's and Arixv papers with Langchain and Nougat 🦉</li>

dev/FAQ/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2274,7 +2274,7 @@ <h2 id="why-the-name-pixi">Why the name <code>pixi</code><a class="headerlink" h
22742274
</div>
22752275
<h2 id="where-is-pixi-build">Where is <code>pixi build</code><a class="headerlink" href="#where-is-pixi-build" title="Permanent link">#</a></h2>
22762276
<p><strong>TL;DR</strong>: It's coming we promise!</p>
2277-
<p><code>pixi build</code> is going to be the subcommand that can generate a conda package out of a pixi project.
2277+
<p><code>pixi build</code> is going to be the subcommand that can generate a conda package out of a Pixi project.
22782278
This requires a solid build tool which we're creating with <a href="https://github.com/prefix-dev/rattler-build"><code>rattler-build</code></a> which will be used as a library in pixi.</p>
22792279

22802280

0 Bytes
Binary file not shown.

dev/advanced/explain_info_command/index.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -2477,18 +2477,18 @@ <h1>Info Command</h1>
24772477
</span><span id="__span-0-26"><a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a> Tasks: docs, test-all, test, build, lint, install, build-docs
24782478
</span></code></pre></div>
24792479
<h2 id="global-info">Global info<a class="headerlink" href="#global-info" title="Permanent link">#</a></h2>
2480-
<p>The first part of the info output is information that is always available and tells you what pixi can read on your machine.</p>
2480+
<p>The first part of the info output is information that is always available and tells you what Pixi can read on your machine.</p>
24812481
<h3 id="platform">Platform<a class="headerlink" href="#platform" title="Permanent link">#</a></h3>
24822482
<p>This defines the platform you're currently on according to pixi.
2483-
If this is incorrect, please file an issue on the <a href="https://github.com/prefix-dev/pixi">pixi repo</a>.</p>
2483+
If this is incorrect, please file an issue on the <a href="https://github.com/prefix-dev/pixi">Pixi repo</a>.</p>
24842484
<h3 id="virtual-packages">Virtual packages<a class="headerlink" href="#virtual-packages" title="Permanent link">#</a></h3>
2485-
<p>The virtual packages that pixi can find on your machine.</p>
2485+
<p>The virtual packages that Pixi can find on your machine.</p>
24862486
<p>In the Conda ecosystem, you can depend on virtual packages.
24872487
These packages aren't real dependencies that are going to be installed, but rather are being used in the solve step to find if a package can be installed on the machine.
24882488
A simple example: When a package depends on Cuda drivers being present on the host machine it can do that by depending on the <code>__cuda</code> virtual package.
2489-
In that case, if pixi cannot find the <code>__cuda</code> virtual package on your machine the installation will fail.</p>
2489+
In that case, if Pixi cannot find the <code>__cuda</code> virtual package on your machine the installation will fail.</p>
24902490
<h3 id="cache-dir">Cache dir<a class="headerlink" href="#cache-dir" title="Permanent link">#</a></h3>
2491-
<p>The directory where pixi stores its cache.
2491+
<p>The directory where Pixi stores its cache.
24922492
Checkout the <a href="../../environments/environment/#caching-packages">cache documentation</a> for more information.</p>
24932493
<h3 id="auth-storage">Auth storage<a class="headerlink" href="#auth-storage" title="Permanent link">#</a></h3>
24942494
<p>Check the <a href="../../deployment/authentication/">authentication documentation</a></p>
@@ -2501,7 +2501,7 @@ <h2 id="workspace-info">Workspace info<a class="headerlink" href="#workspace-inf
25012501
<h3 id="manifest-file">Manifest file<a class="headerlink" href="#manifest-file" title="Permanent link">#</a></h3>
25022502
<p>The path to the <a href="../../reference/pixi_manifest/">manifest file</a> that describes the workspace.</p>
25032503
<h3 id="last-updated">Last updated<a class="headerlink" href="#last-updated" title="Permanent link">#</a></h3>
2504-
<p>The last time the lock file was updated, either manually or by pixi itself.</p>
2504+
<p>The last time the lock file was updated, either manually or by Pixi itself.</p>
25052505
<h2 id="environment-info">Environment info<a class="headerlink" href="#environment-info" title="Permanent link">#</a></h2>
25062506
<p>The environment info defined per environment. If you don't have any environments defined, this will only show the <code>default</code> environment.</p>
25072507
<h3 id="features">Features<a class="headerlink" href="#features" title="Permanent link">#</a></h3>

dev/advanced/installation/index.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -2448,7 +2448,7 @@ <h2 id="update">Update<a class="headerlink" href="#update" title="Permanent link
24482448
<p>Updating is as simple as installing, rerunning the installation script gets you the latest version.</p>
24492449
<p><div class="language-shell highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>pixi<span class="w"> </span>self-update
24502450
</span></code></pre></div>
2451-
Or get a specific pixi version using:
2451+
Or get a specific Pixi version using:
24522452
<div class="language-shell highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>pixi<span class="w"> </span>self-update<span class="w"> </span>--version<span class="w"> </span>x.y.z
24532453
</span></code></pre></div></p>
24542454
<div class="admonition note">
@@ -2457,20 +2457,20 @@ <h2 id="update">Update<a class="headerlink" href="#update" title="Permanent link
24572457
you must use the built-in update mechanism. e.g. <code>brew upgrade pixi</code>.</p>
24582458
</div>
24592459
<h2 id="alternative-installation-methods">Alternative Installation Methods<a class="headerlink" href="#alternative-installation-methods" title="Permanent link">#</a></h2>
2460-
<p>Although we recommend installing pixi through the above method we also provide additional installation methods.</p>
2460+
<p>Although we recommend installing Pixi through the above method we also provide additional installation methods.</p>
24612461
<h3 id="homebrew">Homebrew<a class="headerlink" href="#homebrew" title="Permanent link">#</a></h3>
2462-
<p>Pixi is available via homebrew. To install pixi via homebrew simply run:</p>
2462+
<p>Pixi is available via homebrew. To install Pixi via homebrew simply run:</p>
24632463
<div class="language-shell highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>brew<span class="w"> </span>install<span class="w"> </span>pixi
24642464
</span></code></pre></div>
24652465
<h3 id="windows-installer">Windows Installer<a class="headerlink" href="#windows-installer" title="Permanent link">#</a></h3>
24662466
<p>We provide an <code>msi</code> installer on <a href="https://github.com/prefix-dev/pixi/releases/latest">our GitHub releases page</a>.
2467-
The installer will download pixi and add it to the path.</p>
2467+
The installer will download Pixi and add it to the path.</p>
24682468
<h3 id="winget">Winget<a class="headerlink" href="#winget" title="Permanent link">#</a></h3>
24692469
<div class="language-text highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>winget install prefix-dev.pixi
24702470
</span></code></pre></div>
24712471
<h3 id="install-from-source">Install From Source<a class="headerlink" href="#install-from-source" title="Permanent link">#</a></h3>
24722472
<p>pixi is 100% written in Rust, and therefore it can be installed, built and tested with cargo.
2473-
To start using pixi from a source build run:</p>
2473+
To start using Pixi from a source build run:</p>
24742474
<div class="language-shell highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>cargo<span class="w"> </span>install<span class="w"> </span>--locked<span class="w"> </span>--git<span class="w"> </span>https://github.com/prefix-dev/pixi.git<span class="w"> </span>pixi
24752475
</span></code></pre></div>
24762476
<p>We don't publish to <code>crates.io</code> anymore, so you need to install it from the repository.
@@ -2497,7 +2497,7 @@ <h2 id="installer-script-options">Installer Script Options<a class="headerlink"
24972497
<tbody>
24982498
<tr>
24992499
<td><code>PIXI_VERSION</code></td>
2500-
<td>The version of pixi getting installed, can be used to up- or down-grade.</td>
2500+
<td>The version of Pixi getting installed, can be used to up- or down-grade.</td>
25012501
<td><code>latest</code></td>
25022502
</tr>
25032503
<tr>
@@ -2507,7 +2507,7 @@ <h2 id="installer-script-options">Installer Script Options<a class="headerlink"
25072507
</tr>
25082508
<tr>
25092509
<td><code>PIXI_ARCH</code></td>
2510-
<td>The architecture the pixi version was built for.</td>
2510+
<td>The architecture the Pixi version was built for.</td>
25112511
<td><code>uname -m</code></td>
25122512
</tr>
25132513
<tr>
@@ -2544,7 +2544,7 @@ <h2 id="installer-script-options">Installer Script Options<a class="headerlink"
25442544
<tr>
25452545
<td><code>PixiVersion</code></td>
25462546
<td><code>PIXI_VERSION</code></td>
2547-
<td>The version of pixi getting installed, can be used to up- or down-grade.</td>
2547+
<td>The version of Pixi getting installed, can be used to up- or down-grade.</td>
25482548
<td><code>latest</code></td>
25492549
</tr>
25502550
<tr>

dev/advanced/shebang/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2134,7 +2134,7 @@ <h1 id="using-pixi-exec-to-create-self-contained-scripts">Using <code>pixi exec<
21342134
So in total, <code>pixi exec --spec bat -- bash -e use-bat.sh</code> is being executed when you run <code>./use-bat.sh</code>.</p>
21352135
</div>
21362136
<p>You can also write self-contained python files that ship with their dependencies.
2137-
This example shows a very simple CLI that installs a pixi environment to an arbitrary prefix using <a href="https://conda.github.io/rattler/py-rattler"><code>py-rattler</code></a> and <a href="https://typer.tiangolo.com"><code>typer</code></a>.</p>
2137+
This example shows a very simple CLI that installs a Pixi environment to an arbitrary prefix using <a href="https://conda.github.io/rattler/py-rattler"><code>py-rattler</code></a> and <a href="https://typer.tiangolo.com"><code>typer</code></a>.</p>
21382138
<div class="language-python highlight"><span class="filename">install-pixi-environment-to-prefix.py</span><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="ch">#!/usr/bin/env -S pixi exec --spec py-rattler&gt;=0.10.0,&lt;0.11 --spec typer&gt;=0.15.0,&lt;0.16 -- python</span>
21392139
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
21402140
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="kn">import</span><span class="w"> </span><span class="nn">asyncio</span>

dev/build/backends/index.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -2177,9 +2177,9 @@
21772177

21782178
<h1>Build Backends</h1>
21792179

2180-
<p>To decouple the building of a conda package from pixi we provide something what are called build backends.
2181-
These are essentially executables following a specific protocol that is implemented for both pixi and the build backend.
2182-
This also allows for decoupling of the build backend from pixi and it's manifest specification.</p>
2180+
<p>To decouple the building of a conda package from Pixi we provide something what are called build backends.
2181+
These are essentially executables following a specific protocol that is implemented for both Pixi and the build backend.
2182+
This also allows for decoupling of the build backend from Pixi and it's manifest specification.</p>
21832183
<p>The backends we are currently developing are available in the following <a href="https://prefix.dev/channels/pixi-build-backends">conda channel</a>.
21842184
And are being developed in the <a href="https://github.com/prefix-dev/pixi-build-backends">pixi-build-backends</a> repository.</p>
21852185
<h3 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h3>
@@ -2192,7 +2192,7 @@ <h3 id="installation">Installation<a class="headerlink" href="#installation" tit
21922192
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="p">]</span>
21932193
</span></code></pre></div>
21942194
<ol>
2195-
<li>This will allow pixi to install desired backends from the <code>pixi-build-backends</code> channel, and any requirements from <code>conda-forge</code>. Backends are installed into isolated environments, and will be shared across pixi workspaces.</li>
2195+
<li>This will allow Pixi to install desired backends from the <code>pixi-build-backends</code> channel, and any requirements from <code>conda-forge</code>. Backends are installed into isolated environments, and will be shared across Pixi workspaces.</li>
21962196
</ol>
21972197
<h3 id="overriding-the-build-backend">Overriding the Build Backend<a class="headerlink" href="#overriding-the-build-backend" title="Permanent link">#</a></h3>
21982198
<p>Sometimes you want to override the build backend that is used by pixi. Meaning overriding the backend that is specified in the <a href="../../reference/pixi_manifest/#the-build-system"><code>[package.build]</code></a>. We currently have two environment variables that allow for this:</p>

dev/build/cpp/index.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -2287,7 +2287,7 @@
22872287

22882288
<h1 id="tutorial-building-a-c-package">Tutorial: Building a C++ package<a class="headerlink" href="#tutorial-building-a-c-package" title="Permanent link">#</a></h1>
22892289
<p>This example shows how to build a C++ package with CMake and use it together with <code>pixi-build</code>.
2290-
To read more about how building packages work with pixi see the <a href="../getting_started/">Getting Started</a> guide.</p>
2290+
To read more about how building packages work with Pixi see the <a href="../getting_started/">Getting Started</a> guide.</p>
22912291
<p>We'll start off by creating a workspace that use <a href="https://github.com/wjakob/nanobind">nanobind</a> to build Python bindings.
22922292
That we can also test using pixi.
22932293
We'll later combine this example together with a Python package.</p>
@@ -2348,7 +2348,7 @@ <h3 id="the-pixitoml-file">The <code>pixi.toml</code> file<a class="headerlink"
23482348
</span><span id="__span-2-28"><a id="__codelineno-2-28" name="__codelineno-2-28" href="#__codelineno-2-28"></a><span class="n">python</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;3.12.*&quot;</span><span class="w"> </span><span class="c1"># (7)!</span>
23492349
</span></code></pre></div>
23502350
<ol>
2351-
<li>Add the <strong>preview</strong> feature <code>pixi-build</code> that enables pixi to build the package.</li>
2351+
<li>Add the <strong>preview</strong> feature <code>pixi-build</code> that enables Pixi to build the package.</li>
23522352
<li>These are the workspace dependencies. We add our own package as well as Python so that we can later run our package.</li>
23532353
<li>Let's add a task that will run our test</li>
23542354
<li>This is where we specify the package name and version.
@@ -2419,9 +2419,9 @@ <h2 id="testing-if-everything-works">Testing if everything works<a class="header
24192419
</span></code></pre></div>
24202420
<p>This command builds the bindings, installs them and then runs the <code>test</code> task.</p>
24212421
<h2 id="conclusion">Conclusion<a class="headerlink" href="#conclusion" title="Permanent link">#</a></h2>
2422-
<p>In this tutorial, we created a pixi package using C++.
2422+
<p>In this tutorial, we created a Pixi package using C++.
24232423
It can be used as-is, to upload to a conda channel.
2424-
In another tutorial we will learn how to add multiple pixi packages to the same workspace and let one pixi package use another.</p>
2424+
In another tutorial we will learn how to add multiple Pixi packages to the same workspace and let one Pixi package use another.</p>
24252425
<p>Thanks for reading! Happy Coding 🚀</p>
24262426
<p>Any questions? Feel free to reach out or share this tutorial on <a href="https://twitter.com/prefix_dev">X</a>, <a href="https://discord.gg/kKV8ZxyzY4">join our Discord</a>, <a href="mailto:hi@prefix.dev">e-mail</a> us or follow our <a href="https://github.com/prefix-dev">GitHub</a>.</p>
24272427

dev/build/getting_started/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -2196,7 +2196,7 @@
21962196
<h1>Getting started</h1>
21972197

21982198
<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">#</a></h2>
2199-
<p>Next to managing workflows and environments, pixi can also build packages.
2199+
<p>Next to managing workflows and environments, Pixi can also build packages.
22002200
This is useful for the following reasons:</p>
22012201
<ul>
22022202
<li>Building and uploading a package to a conda channel</li>
@@ -2216,7 +2216,7 @@ <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" tit
22162216
</ol>
22172217
</div>
22182218
<h2 id="setting-up-the-manifest">Setting up the Manifest<a class="headerlink" href="#setting-up-the-manifest" title="Permanent link">#</a></h2>
2219-
<p>This is an overview of the pixi manifest using <code>pixi-build</code>.</p>
2219+
<p>This is an overview of the Pixi manifest using <code>pixi-build</code>.</p>
22202220
<div class="language-toml highlight"><span class="filename">pixi.toml</span><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Specifies properties for the whole workspace</span>
22212221
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="k">[workspace]</span>
22222222
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="n">preview</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;pixi-build&quot;</span><span class="p">]</span>

0 commit comments

Comments
 (0)