Clarify step 7 of build process - #1337
Open
oscarlevin wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies the build instructions in the server setup documentation so that step 7 is consistent with the prior guidance about using uv run when not inside the activated virtual environment.
Changes:
- Update step 7 to use
uv run build fullwhen outside the virtual environment. - Add a parenthetical note that
build fullstill works when the virtual environment remains activated.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
docs/source/building_servers.rst:26
- This step mixes manual numbering ("7.") with the earlier auto-numbered list ("#."), and the parenthetical implies that using an activated virtualenv affects access to
.env/environment variables. Activating/deactivating the venv doesn't change whether environment variables are present, so this wording is likely misleading. Consider continuing the auto-numbered list and explicitly stating the two equivalent command forms (outside vs inside the venv).
7. Run the ``build`` script from the ``rs`` folder by doing ``uv run build full`` (this is better than running ``build full`` from an active virtual environment because you definitely need the .env variables here). The first step of this script will verify that you have all of your environment variables defined. It will then build the python wheels for all the runestone components and then build the docker servers. This will take a while.
Member
|
The build command loads the |
This file contains hidden or 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
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.
While setting up my runestone dev environment, I got confused in section 13. Step 6 says to leave the virtual environment. There is then a note about how in the future commands that should happen inside the environment will include
uv run. But step 7 omits this.