-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Documentation: manual installation of manim as a local package #4456
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -329,3 +329,30 @@ version satisfies the requirement. Change the line to, for example | |||||||||||||||||||||||||||
| to pin the python version to `3.12`. Finally, run `uv sync`, and your | ||||||||||||||||||||||||||||
| environment is updated! | ||||||||||||||||||||||||||||
| ::: | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| :::{dropdown} Installing the current repo as a pip package | ||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||
| If there are problems with the current release of manim. | ||||||||||||||||||||||||||||
| You can install the current repository as a pip package by running | ||||||||||||||||||||||||||||
|
Comment on lines
+336
to
+337
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| 'pip install git+https://github.com/ManimCommunity/manim.git@main' | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| or | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| 'uv add git+https://github.com/ManimCommunity/manim.git@main' | ||||||||||||||||||||||||||||
|
Comment on lines
+338
to
+343
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The code fences here are not correct. Like in the sections above, I'd only mention the
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. | ||||||||||||||||||||||||||||
|
Comment on lines
+345
to
+357
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
|
||||||||||||||||||||||||||||
| ::: | ||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to be reverted.