Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ release. Write RST between the following start and end comments.-->
<!--changelog-end-->

## Checklist
- [ ] 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
- [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
Comment on lines +16 to +18
Copy link
Member

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.

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


<!-- Do not modify the lines below. These are for the reviewers of your PR -->
## Reviewer Checklist
Expand Down
27 changes: 27 additions & 0 deletions docs/source/installation/uv.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:::{dropdown} Installing the current repo as a pip package
:::{dropdown} Installing the latest development version

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
Copy link
Member

Choose a reason for hiding this comment

The 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
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


'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
Copy link
Member

Choose a reason for hiding this comment

The 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 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
```


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
Copy link
Member

Choose a reason for hiding this comment

The 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
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.

:::