Skip to content

docs: add Windows C++ Build Tools guidance - #4982

Open
SR0725 wants to merge 2 commits into
ManimCommunity:mainfrom
SR0725:docs/windows-cpp-build-tools
Open

docs: add Windows C++ Build Tools guidance#4982
SR0725 wants to merge 2 commits into
ManimCommunity:mainfrom
SR0725:docs/windows-cpp-build-tools

Conversation

@SR0725

@SR0725 SR0725 commented Sep 1, 2026

Copy link
Copy Markdown

Overview: What does this pull request change?

Adds a conditional note to the Windows installation steps for users whose uv add manim run reports that Microsoft Visual C++ is required. The note links to Microsoft's current Build Tools instructions, names the Desktop 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.md
  • make 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 existing typst-mobjects cross-reference warnings and the local environment does not have Graphviz's dot command. The changed page did not produce a warning.

Contributor Checklist

  • I have read the Contributing Guidelines
  • I have read the Code of Conduct
  • I have followed the style guide for documentation
  • I have linked the issue this pull request closes
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

@GniLudio

GniLudio commented Sep 1, 2026

Copy link
Copy Markdown
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.

@SR0725

SR0725 commented Sep 2, 2026

Copy link
Copy Markdown
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.

@GniLudio

GniLudio commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Thanks.

Can you move the tip after

Manim is now installed in your local project environment!

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.

Add instructions to install the Microsoft C++ Build Tools to the installation guide

2 participants