diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md index ff27ede4d5..03b803ba82 100644 --- a/.github/PULL_REQUEST_TEMPLATE/documentation.md +++ b/.github/PULL_REQUEST_TEMPLATE/documentation.md @@ -13,9 +13,9 @@ release. Write RST between the following start and end comments.--> ## 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 ## Reviewer Checklist diff --git a/docs/source/installation/uv.md b/docs/source/installation/uv.md index ab2ccec554..b31c9c8ba1 100644 --- a/docs/source/installation/uv.md +++ b/docs/source/installation/uv.md @@ -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 +If there are problems with the current release of manim. +You can install the current repository as a pip package by running + +'pip install git+https://github.com/ManimCommunity/manim.git@main' + +or + +'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. +:::