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

Remove the recommendation about the bundled package #12318

Open
AA-Turner opened this issue Apr 24, 2024 · 2 comments
Open

Remove the recommendation about the bundled package #12318

AA-Turner opened this issue Apr 24, 2024 · 2 comments

Comments

@AA-Turner
Copy link
Member

AA-Turner commented Apr 24, 2024

I think we should just remove the recommendation about the bundled package and rather suggest using pip in the first place.

Originally posted by @picnixz in #12239 (comment)

@picnixz
Copy link
Member

picnixz commented Apr 24, 2024

I personally think we should recommend virtualenv + pip in the first place; at least, we won't have any surprises (or there should be none!) @n-peugnet do you follow me for that call?

@n-peugnet
Copy link
Contributor

IMO virtualenv + pip is a safe and portable default that would work as expected everywhere. The virtualenv part should be mandatory in the install instructions instead of recommended afterwards currently.
The README should also be updated, maybe as a link to the installation page?

Another possibility would be to recommend pipx as suggested in the pip install warning. I'm not used to this tool but is seems like a fine way to install python CLI tools with dependency isolation.

I don't think the recommendation to use system packages should be removed. For most of the people this is probably the easiest way to install Sphinx, but maybe a warning should be added that mixing user installed pip and system packages can cause issues?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants