Skip to content

docs(install): add Windows BUILD_MONAI command variants#8955

Open
SID-6921 wants to merge 1 commit into
Project-MONAI:devfrom
SID-6921:docs/windows-build-monai-instructions
Open

docs(install): add Windows BUILD_MONAI command variants#8955
SID-6921 wants to merge 1 commit into
Project-MONAI:devfrom
SID-6921:docs/windows-build-monai-instructions

Conversation

@SID-6921

Copy link
Copy Markdown

Summary

Adds explicit Windows examples for BUILD_MONAI=1 installation commands in the installation docs:

  • PowerShell syntax ($env:BUILD_MONAI = "1")
  • CMD syntax (set BUILD_MONAI=1)

Why

Current docs show POSIX-style env var assignment only, which does not work out-of-the-box on Windows shells. This update documents equivalent commands for Windows users.

Scope

  • docs/source/installation.md
  • Covers both GitHub install and editable install flows

Closes #6119

@coderabbitai

coderabbitai Bot commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5c01597b-cf09-4bbd-a0bc-cb9367b6d59a

📥 Commits

Reviewing files that changed from the base of the PR and between 1de4810 and 6e895fa.

📒 Files selected for processing (1)
  • docs/source/installation.md
✅ Files skipped from review due to trivial changes (1)
  • docs/source/installation.md

📝 Walkthrough

Walkthrough

Adds Windows-specific installation instructions to docs/source/installation.md. Under "Option 1", new PowerShell and bat code blocks show how to set BUILD_MONAI=1 before running pip install and the --no-build-isolation variant. Under "Option 2 (editable installation)", matching Windows blocks are added for the editable install workflow.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the doc change and highlights the Windows BUILD_MONAI install variants.
Description check ✅ Passed The description includes summary, rationale, scope, and issue closure, with only noncritical template items omitted.
Linked Issues check ✅ Passed The docs update provides Windows CMD and PowerShell BUILD_MONAI instructions for both install flows, matching #6119.
Out of Scope Changes check ✅ Passed The change is limited to installation documentation and stays within the requested Windows instructions scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Signed-off-by: SID <nandasiddhardha@gmail.com>
@SID-6921 SID-6921 force-pushed the docs/windows-build-monai-instructions branch from 1de4810 to 6e895fa Compare June 27, 2026 20:05
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.

Including Windows BUILD_MONAI instructions in documentation

1 participant