Docs update for virtual environments #448
Merged
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
aspeake
commented
Dec 3, 2024
| @@ -357,7 +357,7 @@ | |||
|
|
|||
|
|
|||
| # Example configuration for intersphinx: refer to the Python standard library. | |||
| intersphinx_mapping = {'https://docs.python.org/3': None} | |||
| # intersphinx_mapping = {'https://docs.python.org/3': None} | |||
There was a problem hiding this comment.
Not used and was failing locally with the latest version of sphinx-build
aspeake
commented
Dec 3, 2024
| @@ -44,7 +44,7 @@ Mac OS | |||
| 0. (Optional) Install a package manager | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
|
|
|||
| The Mac OS ships with Python already installed. Installing and using a package manager will make it easy to ensure that any additional installations of Python do not interfere with the version of Python included with the operating system. Homebrew_ is a popular package manager, but there are other options, such as MacPorts and Fink. | |||
aspeake
commented
Dec 3, 2024
|
|
||
| Once Python 3 installation is complete and a virtual environment is activated, the Scout package and its dependencies can be installed. pip [#f1]_ is the tool you will use to install add-ons specific to Python 3. Run the following from your Scout installation directory to install the Scout package:: | ||
|
|
||
| python -m pip install . |
There was a problem hiding this comment.
Note: with the assumption that a virtual environment is used, python is the command to point to the correct version inside the virtual env. Even without an environment, python should still work for Windows users if it was added to PATH at install. I updated to use python instead of py -3 throughout the docs.
jtlangevin
approved these changes
Dec 9, 2024
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.
More detailed explanations of setting up Scout in a virtual environment.