Skip to content

Commit

Permalink
docs: fix list renderings (#2488)
Browse files Browse the repository at this point in the history
  • Loading branch information
ruben-arts authored Nov 15, 2024
1 parent fa3f999 commit 25da141
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
1 change: 1 addition & 0 deletions docs/features/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ If this is not the case then all the commands that use the environment will auto
On environment installation, pixi will write a small file to the environment that contains some metadata about installation.
This file is called `pixi` and is located in the `conda-meta` folder of the environment.
This file contains the following information:

- `manifest_path`: The path to the manifest file that describes the project used to create this environment
- `environment_name`: The name of the environment
- `pixi_version`: The version of pixi that was used to create this environment
Expand Down
12 changes: 6 additions & 6 deletions docs/features/system_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ This can be particularly useful when working on systems that do not meet the pro
You can override virtual packages by setting the following environment variables:

- `CONDA_OVERRIDE_CUDA`
- Description: Sets the CUDA version.
- Usage Example: `CONDA_OVERRIDE_CUDA=11`
- Description: Sets the CUDA version.
- Usage Example: `CONDA_OVERRIDE_CUDA=11`
- `CONDA_OVERRIDE_GLIBC`
- Description: Sets the glibc version.
- Usage Example: `CONDA_OVERRIDE_GLIBC=2.28`
- Description: Sets the glibc version.
- Usage Example: `CONDA_OVERRIDE_GLIBC=2.28`
- `CONDA_OVERRIDE_OSX`
- Description: Sets the macOS version.
- Usage Example: `CONDA_OVERRIDE_OSX=13.0`
- Description: Sets the macOS version.
- Usage Example: `CONDA_OVERRIDE_OSX=13.0`

## Additional Resources

Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,7 @@ pixi exec --force-reinstall -s ipython -s py-rattler ipython
Removes dependencies from the [manifest file](project_configuration.md).

If the project manifest is a `pyproject.toml`, removing a pypi dependency with the `--pypi` flag will remove it from either

- the native pyproject `project.dependencies` array or the native `project.optional-dependencies` table (if a feature is specified)
- pixi `pypi-dependencies` tables of the default or a named feature (if a feature is specified)

Expand Down
10 changes: 6 additions & 4 deletions docs/reference/project_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,12 +174,13 @@ Options:
Using packages from different incompatible channels like `conda-forge` and `main` can lead to hard to debug ABI incompatibilities.

We strongly recommend not to switch the default.

- `disabled`: There is no priority, all package variants from all channels will be set per package name and solved as one.
Care should be taken when using this option.
Since package variants can come from _any_ channel when you use this mode, packages might not be compatible.
This can cause hard to debug ABI incompatibilities.
Care should be taken when using this option.
Since package variants can come from _any_ channel when you use this mode, packages might not be compatible.
This can cause hard to debug ABI incompatibilities.

We strongly discourage using this option.
We strongly discourage using this option.

```toml
channel-priority = "disabled"
Expand Down Expand Up @@ -761,6 +762,7 @@ test = {features = ["test"]}
```

When an environment comprises several features (including the default feature):

- The `activation` and `tasks` of the environment are the union of the `activation` and `tasks` of all its features.
- The `dependencies` and `pypi-dependencies` of the environment are the union of the `dependencies` and `pypi-dependencies` of all its features. This means that if several features define a requirement for the same package, both requirements will be combined. Beware of conflicting requirements across features added to the same environment.
- The `system-requirements` of the environment is the union of the `system-requirements` of all its features. If multiple features specify a requirement for the same system package, the highest version is chosen.
Expand Down

0 comments on commit 25da141

Please sign in to comment.