docs: add Windows BUILD_MONAI install instructions#8906
Conversation
The installation guide only documents the POSIX inline form `BUILD_MONAI=1 pip install ...` for building the C++/CUDA extensions. That `VAR=value command` syntax is not supported by Windows cmd.exe or PowerShell, so the documented commands fail out of the box for Windows users. Add cmd.exe and PowerShell snippets to both the system-wide (Option 1) and editable (Option 2) install sections: set the environment variable first, then run the install command. Closes Project-MONAI#6119 Signed-off-by: Lanre Shittu <136805224+Shizoqua@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughInstallation documentation now includes Windows-specific instructions for setting the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
dzenanz
left a comment
There was a problem hiding this comment.
Thanks for updating the docs. Sometimes it is obvious what needs to be done, but it is better to have the correct thing in the docs.
Fixes #6119 .
Description
docs/source/installation.mdonly documents the POSIX inline formBUILD_MONAI=1 pip install ...for building the MONAI C++/CUDA extensions. ThisVAR=value commandsyntax is not supported by Windowscmd.exeor PowerShell, so the documented commands fail out of the box on Windows.This adds short cmd.exe and PowerShell snippets to both install flows (Option 1 system-wide and Option 2 editable): set the environment variable first, then run the existing
pip installcommand. Theset BUILD_MONAI=1form is the one confirmed working on Windows 11 in the issue thread.Types of changes
How tested
bat/powershellfenced blocks use valid Pygments lexers and lex without error tokens, so the strict docs build (build_docs.yml) emits no new warnings.