docs: add Windows C++ Build Tools guidance - #4982
Open
SR0725 wants to merge 2 commits into
Open
Conversation
Contributor
|
Please change the link to https://visualstudio.microsoft.com/visual-cpp-build-tools/, as that one is mentioned when installing a library fails. Also, please add the link to the changed documentation page in the PR description. |
Author
|
Updated both: the installation note now uses the requested Visual C++ Build Tools link, and the PR description links to the Windows installation preview. I reran pre-commit and the 33 doctests after the change; both pass. |
Contributor
|
Thanks. Can you move the tip after |
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.
Overview: What does this pull request change?
Adds a conditional note to the Windows installation steps for users whose
uv add manimrun reports that Microsoft Visual C++ is required. The note links to Microsoft's current Build Tools instructions, names theDesktop development with C++workload, and tells users to reopen the terminal before retrying.Closes #4974.
Motivation and Explanation: Why and how do your changes improve the library?
The existing Windows tab goes straight from creating a project to
uv add manim. When a native dependency needs to be built, users can be blocked by a missing MSVC toolchain without installation steps in this guide. The note is conditional, so users with compatible wheels do not need to install extra tools.Links to added or changed documentation pages
Windows installation preview
Further Information and Comments
Verified with:
UV_NO_CONFIG=1 uvx --isolated pre-commit run --files docs/source/installation/uv.mdmake doctest O=-tskip-manim(33 tests, 0 failures)I also ran
make html O='-W --keep-going -tskip-manim'. It completed the build but exited nonzero because the current checkout reports two existingtypst-mobjectscross-reference warnings and the local environment does not have Graphviz'sdotcommand. The changed page did not produce a warning.Contributor Checklist