From 25da14199c9db058ce8523be9299684ee01ea683 Mon Sep 17 00:00:00 2001 From: Ruben Arts Date: Fri, 15 Nov 2024 14:56:28 +0100 Subject: [PATCH] docs: fix list renderings (#2488) --- docs/features/environment.md | 1 + docs/features/system_requirements.md | 12 ++++++------ docs/reference/cli.md | 1 + docs/reference/project_configuration.md | 10 ++++++---- 4 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/features/environment.md b/docs/features/environment.md index 2e0124e67..e96afc0e9 100644 --- a/docs/features/environment.md +++ b/docs/features/environment.md @@ -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 diff --git a/docs/features/system_requirements.md b/docs/features/system_requirements.md index fc091d09f..2dd6cbfb6 100644 --- a/docs/features/system_requirements.md +++ b/docs/features/system_requirements.md @@ -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 diff --git a/docs/reference/cli.md b/docs/reference/cli.md index b5097d8ea..d83583373 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -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) diff --git a/docs/reference/project_configuration.md b/docs/reference/project_configuration.md index 1559c77f0..8f107fe5e 100644 --- a/docs/reference/project_configuration.md +++ b/docs/reference/project_configuration.md @@ -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" @@ -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.