-
Notifications
You must be signed in to change notification settings - Fork 126
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: Add method of installation via conda #842
Conversation
On conda-forge, this package is called "python-build", not "build". However, this information is only given in README.md and not in docs/installation.rst. Users are likely to read the documentation on https://build.pypa.io/ only, and they are likely to think that the name of the package on conda-forge is also "build", which will make them get into trouble. Fix this problem here.
Python libraries are typically prefixed with "python" in multi-language package indices, and conda-forge is one of many. I'm not sure we need to mention it specifically. |
Conda is a very popular, OS agnostic way to install Python libraries. It comes up all the time when discussing packaging, etc, so I think it would be okay to mention. It's called python-build in the defaults channel too (it's still 0.10 there, though). It was originally called |
Also, very few packages have a |
Is it too late to rename this package to |
Isn't this information already present in the README? |
Yes, it is. Maybe we should try to make sure this is more similar to the readme. |
The habit of conda users may be different from that of pip users and source code users: they often search for the documentation and read it first, and also, it may not be likely for them to realize that such an important information is only present in README but not in the documentation. |
I think it was just an oversight that the same info wasn't added to the docs, in general docs should not have less information than the README. A README is an abbreviated version of the docs, usually. |
We also mention pipx and uv in the readme. Let's add those here too. |
Agreed. Same PR or followup? |
I don't mind, if @GasinAn would prefer to leave that to somebody else, we can do in a follow-up. |
Sorry, I prefer to leave followup to somebody else, because I know few about pipx and uv.😐 |
No problem, we can follow it up. Thanks! |
On conda-forge, this package is called "python-build", not "build". However, this information is only given in README.md and not in docs/installation.rst. Users are likely to read the documentation on https://build.pypa.io/ only, and they are likely to think that the name of the package on conda-forge is also "build", which will make them get into trouble. Fix this problem here.