Skip to content

Clarify step 7 of build process - #1337

Open
oscarlevin wants to merge 2 commits into
RunestoneInteractive:mainfrom
oscarlevin:doc-patch-levin
Open

Clarify step 7 of build process#1337
oscarlevin wants to merge 2 commits into
RunestoneInteractive:mainfrom
oscarlevin:doc-patch-levin

Conversation

@oscarlevin

Copy link
Copy Markdown
Collaborator

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.

@oscarlevin
oscarlevin requested a review from bnmnetp as a code owner August 2, 2026 15:35
Copilot AI review requested due to automatic review settings August 2, 2026 15:35

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 full when outside the virtual environment.
  • Add a parenthetical note that build full still works when the virtual environment remains activated.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings August 2, 2026 16:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@bnmnetp

bnmnetp commented Aug 2, 2026

Copy link
Copy Markdown
Member

The build command loads the .env file with load_dotenv() so they should be loaded either way.

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

Successfully merging this pull request may close these issues.

3 participants