Skip to content

Commit 8d3bd00

Browse files
committed
Documentation: additonal instalation method
1 parent 4dd2937 commit 8d3bd00

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

.github/PULL_REQUEST_TEMPLATE/documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ release. Write RST between the following start and end comments.-->
1313
<!--changelog-end-->
1414

1515
## Checklist
16-
- [ ] I have read the [Contributing Guidelines](https://docs.manim.community/en/latest/contributing.html)
17-
- [ ] I have written a descriptive PR title (see top of PR template for examples)
18-
- [ ] My new documentation builds, looks correctly formatted, and adds no additional build warnings
16+
- [X] I have read the [Contributing Guidelines](https://docs.manim.community/en/latest/contributing.html)
17+
- [X] I have written a descriptive PR title (see top of PR template for examples)
18+
- [X] My new documentation builds, looks correctly formatted, and adds no additional build warnings
1919

2020
<!-- Do not modify the lines below. These are for the reviewers of your PR -->
2121
## Reviewer Checklist

docs/source/installation/uv.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,3 +329,30 @@ version satisfies the requirement. Change the line to, for example
329329
to pin the python version to `3.12`. Finally, run `uv sync`, and your
330330
environment is updated!
331331
:::
332+
333+
334+
335+
:::{dropdown} Installing the current repo as a pip package
336+
If there are problems with the current release of manim.
337+
You can install the current repository as a pip package by running
338+
339+
'pip install git+https://github.com/ManimCommunity/manim.git@main'
340+
341+
or
342+
343+
'uv add git+https://github.com/ManimCommunity/manim.git@main'
344+
345+
If you want to install a specific commit or test some changes to the
346+
source files you'll want to install these packages:
347+
348+
'''
349+
pip install build
350+
pip install bandersnatch
351+
pip install cibuildwheel
352+
'''
353+
354+
After this you should be able to run 'puproject-build' in the root
355+
of the project to create the package under dist. Under which you can
356+
run the interpreter to install any other dependicies and add it into
357+
the pip package.
358+
:::

0 commit comments

Comments
 (0)