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

Fully document pixi.toml format #308

Closed
kszlim opened this issue Aug 28, 2023 · 6 comments
Closed

Fully document pixi.toml format #308

kszlim opened this issue Aug 28, 2023 · 6 comments
Labels
📖 documentation Improvements or additions to documentation 🆘 help wanted Maintainers would like community input ✨ enhancement Feature request

Comments

@kszlim
Copy link

kszlim commented Aug 28, 2023

Problem description

Hi, I think to increase the ease of adopting pixi, please document fully all the different options in the pixi.toml format and explain each section.

Most of the basics are available, but when I look at examples, there are some uses like (build-dependencies) and host/target that aren't fully documented.

Also some references to other package managers and their features and how they can be replicated within pixi would be helpful (for example dependency groups or optional dependencies).

@kszlim kszlim added the ✨ enhancement Feature request label Aug 28, 2023
@baszalmstra baszalmstra added the 📖 documentation Improvements or additions to documentation label Aug 28, 2023
@baszalmstra
Copy link
Contributor

Yes you are completely right. A detailed document about the details of the pixi.toml is already underway. Should probably be online this week. We are also planning on writing some comparisons with other package managers but I cant give you a date yet.

@baszalmstra
Copy link
Contributor

And here it is: https://prefix.dev/docs/pixi/configuration

@kszlim
Copy link
Author

kszlim commented Aug 28, 2023

Awesome, I see there are a lot of proposed enhancements to pixi.toml (as well as supporting pyproject.toml). It would be great to ensure that any such changes are also documented as soon as they land!

Eg.:
#79
#179
#239
#175

Thanks! Pixi is looking really great!

I also notice that you reference pixi build on that page, but the corresponding CLI page doesn't say anything about pixi build

@baszalmstra
Copy link
Contributor

Yeah we should definitely pay attention to update the docs as we add/change features. We will be merging the docs in this repository soon so we can make sure they are updated with a PR.

pixi build is indeed still in development (see this PR: #85). Do you think it would be better if we'd remove that reference from the documentation until that feature lands? Im a bit on the fence about it because some of the configuration in the pixi.toml is mostly there to support pixi build.

@kszlim
Copy link
Author

kszlim commented Aug 29, 2023

I think it'd be fine to keep reference to it, but make note that it's coming soon (and if you have time add a page about pixi build with a huge header that says it's not available yet and links to the issue).

@baszalmstra baszalmstra added the 🆘 help wanted Maintainers would like community input label Sep 11, 2023
@ruben-arts
Copy link
Contributor

I updated it in the new documentation!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation 🆘 help wanted Maintainers would like community input ✨ enhancement Feature request
Projects
None yet
Development

No branches or pull requests

3 participants