Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: first iteration on the documentation of the global feature #2169

Merged

Conversation

ruben-arts
Copy link
Contributor

Not proud of this but it's a start. I rather spend more time on improving the code then documenting my way around it.

@ruben-arts ruben-arts added 📖 documentation Improvements or additions to documentation area:global Related to pixi global labels Oct 1, 2024
@ruben-arts ruben-arts added this to the New `pixi global` milestone Oct 1, 2024
Copy link
Contributor

@Hofer-Julian Hofer-Julian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only had one small comment

docs/features/global_tools.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Hofer-Julian Hofer-Julian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

docs/features/global_tools.md Outdated Show resolved Hide resolved
docs/features/global_tools.md Outdated Show resolved Hide resolved
channels = ["conda-forge"]
dependencies = { python = ">=3.10,<3.11" }
exposed = { py3 = "python3" }
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explain that you can run python by executing py3

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

docs/features/global_tools.md Outdated Show resolved Hide resolved
### Example: Creating a Data Science Sandbox Environment
You can create an environment with multiple tools using the following command:
```shell
pixi global install --environment data-science --expose jupyter=jupyter --expose ipython=ipython jupyter numpy pandas matplotlib ipython
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use fewer packages to avoid that the reader has to scroll

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

```


### Example: Creating a Data Science Sandbox Environment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example should come after Adding a series of tools at once. It is more complicated

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Comment on lines 129 to +135
tracing::debug!(
"Found executables: {:?} in {:?}",
executables,
"In packages: {}, found executables: {:?} ",
prefix_packages
.iter()
.map(|p| p.repodata_record.package_record.name.as_source())
.collect::<Vec<_>>()
.map(|rec| rec.repodata_record.package_record.name.as_normalized())
.join(", "),
executables
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change still valid?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

@Hofer-Julian Hofer-Julian enabled auto-merge (squash) October 10, 2024 15:26
@Hofer-Julian Hofer-Julian merged commit d38f723 into prefix-dev:feature/pixi-global Oct 10, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:global Related to pixi global 📖 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants