Add instructions for virtual environments #157
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, we just linked to the documentation for "virtual environments". Users have several options for creating these, and providing configuration commands that can be copied-and-pasted into a terminal may improve the out-of-box experience. The changes in this commit add instructions for venv and uv. Each option is displayed as a separate tab, so it should be straightforward to add more options in the future. Signed-off-by: John Pennycook <[email protected]>
Pennycook
added
documentation
laserkelvin
approved these changes
Feb 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we just linked to the documentation for "virtual environments".
Users have several options for creating these, and providing configuration commands that can be copied-and-pasted into a terminal may improve the out-of-box experience.
The changes in this commit add instructions for venv and uv. Each option is displayed as a separate tab, so it should be straightforward to add more options in the future.
Related issues
Closes #151.
Proposed changes
sphinx_inline_tabsextension to the documentation, to enable tabbed code blocks.venvanduv.