Documentation: manual installation of manim as a local package #4456
+30
−3
Conversation
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
for more information, see https://pre-commit.ci
behackl
requested changes
Jan 12, 2026
Member
behackl
left a comment
behackl
left a comment
There was a problem hiding this comment.
Hi! Thanks for the proposed changes and sorry for the long delay -- I've left some suggestions to remove potentially confusing and unnecessary instructions. Please take a look!
Comment on lines
+16
to
+18
| - [X] I have read the [Contributing Guidelines](https://docs.manim.community/en/latest/contributing.html) | ||
| - [X] I have written a descriptive PR title (see top of PR template for examples) | ||
| - [X] My new documentation builds, looks correctly formatted, and adds no additional build warnings |
Member
There was a problem hiding this comment.
This needs to be reverted.
Suggested change
| - [X] I have read the [Contributing Guidelines](https://docs.manim.community/en/latest/contributing.html) | |
| - [X] I have written a descriptive PR title (see top of PR template for examples) | |
| - [X] My new documentation builds, looks correctly formatted, and adds no additional build warnings | |
| - [ ] I have read the [Contributing Guidelines](https://docs.manim.community/en/latest/contributing.html) | |
| - [ ] I have written a descriptive PR title (see top of PR template for examples) | |
| - [ ] My new documentation builds, looks correctly formatted, and adds no additional build warnings |
|
|
||
|
|
||
|
|
||
| :::{dropdown} Installing the current repo as a pip package |
Member
There was a problem hiding this comment.
Suggested change
| :::{dropdown} Installing the current repo as a pip package | |
| :::{dropdown} Installing the latest development version |
Comment on lines
+336
to
+337
| If there are problems with the current release of manim. | ||
| You can install the current repository as a pip package by running |
Member
There was a problem hiding this comment.
Suggested change
| If there are problems with the current release of manim. | |
| You can install the current repository as a pip package by running | |
| If you want to install the latest (potentially unstable!) | |
| development version of Manim from our source repository | |
| [on GitHub](https://github.com/ManimCommunity/manim), then | |
| simply run |
Comment on lines
+338
to
+343
|
|
||
| 'pip install git+https://github.com/ManimCommunity/manim.git@main' | ||
|
|
||
| or | ||
|
|
||
| 'uv add git+https://github.com/ManimCommunity/manim.git@main' |
Member
There was a problem hiding this comment.
The code fences here are not correct. Like in the sections above, I'd only mention the uv command.
Suggested change
| 'pip install git+https://github.com/ManimCommunity/manim.git@main' | |
| or | |
| 'uv add git+https://github.com/ManimCommunity/manim.git@main' | |
| ``` | |
| uv add git+https://github.com/ManimCommunity/manim.git@main | |
| ``` |
Comment on lines
+345
to
+357
| If you want to install a specific commit or test some changes to the | ||
| source files you'll want to install these packages: | ||
|
|
||
| ''' | ||
| pip install build | ||
| pip install bandersnatch | ||
| pip install cibuildwheel | ||
| ''' | ||
|
|
||
| After this you should be able to run 'pyproject-build' in the root | ||
| of the project to create the package under dist. Under which you can | ||
| run the interpreter to install any other dependicies and add it into | ||
| the pip package. |
Member
There was a problem hiding this comment.
This seems very specific, you shouldn't ever really need to install cibuildwheel or bandersnatch just if you want to get a specific commit. I'd delete this section from the dropdown.
Suggested change
| If you want to install a specific commit or test some changes to the | |
| source files you'll want to install these packages: | |
| ''' | |
| pip install build | |
| pip install bandersnatch | |
| pip install cibuildwheel | |
| ''' | |
| After this you should be able to run 'pyproject-build' in the root | |
| of the project to create the package under dist. Under which you can | |
| run the interpreter to install any other dependicies and add it into | |
| the pip package. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
Motivation and Explanation: Why and how do your changes improve the library?
Updates the installation documentation to include a troubleshooting method for installing the source
files of the project independent of current releases. Closes #4439
Links to added or changed documentation pages
https://docs.manim.community/en/latest/contributing.html
Further Information and Comments
Reviewer Checklist