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

Document --require-virtualenv flag #10588

Merged
merged 8 commits into from
Oct 18, 2021
Merged

Document --require-virtualenv flag #10588

merged 8 commits into from
Oct 18, 2021

Conversation

tusharsadhwani
Copy link
Contributor

@tusharsadhwani tusharsadhwani commented Oct 14, 2021

Resolves #10456

Edit: Hey! This PR is fairly incomplete right now, it was made during a live stream to help show how one might find, fix and make PRs to open source. I'll be taking a look at the sphinx code and see why readthedocs isn't picking up the flag as well.

Is there any other place that you might want to document the --require-venv flag / env var? Do let me know, I'd be happy to write it down.

@tusharsadhwani tusharsadhwani marked this pull request as draft October 14, 2021 16:57
@tusharsadhwani tusharsadhwani marked this pull request as ready for review October 14, 2021 17:20
@tusharsadhwani
Copy link
Contributor Author

Okay, I get what's going on now.

require_virtualenv is marked as a "general option", as in, it can be passed to any command. But that prevents it in showing up in readthedocs pages for pip install, for example. And I don't think that's a good thing.

@tusharsadhwani
Copy link
Contributor Author

So here's what I'd suggest:

In the Usage section, we can have a sub-heading called "Virtualenvs", and document it there.

Like so:
image

Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
@uranusjr uranusjr merged commit ee9ac15 into pypa:main Oct 18, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document PIP_REQUIRE_VIRTUALENV and --require-venv
2 participants