From 8d3bd003f72f026d2d3d3aad6bc48e6fd6f92e79 Mon Sep 17 00:00:00 2001 From: CA3000 <93896083+CA3000@users.noreply.github.com> Date: Sat, 25 Oct 2025 11:18:17 +1100 Subject: [PATCH 1/3] Documentation: additonal instalation method --- .../PULL_REQUEST_TEMPLATE/documentation.md | 6 ++--- docs/source/installation/uv.md | 27 +++++++++++++++++++ 2 files changed, 30 insertions(+), 3 deletions(-) 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..36eb6974fd 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 'puproject-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. +::: From 7d82ae08cd8fae5b5e571f5d0f4ac0e135a0c6f6 Mon Sep 17 00:00:00 2001 From: Conor Date: Sat, 25 Oct 2025 12:58:40 +1100 Subject: [PATCH 2/3] Typo fix --- docs/source/installation/uv.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/installation/uv.md b/docs/source/installation/uv.md index 36eb6974fd..a14c0f5aa4 100644 --- a/docs/source/installation/uv.md +++ b/docs/source/installation/uv.md @@ -351,7 +351,7 @@ pip install bandersnatch pip install cibuildwheel ''' -After this you should be able to run 'puproject-build' in the root +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. From 9384573203ea32c07ea2edeb3b212f163e6d0c89 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 25 Oct 2025 02:00:32 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/installation/uv.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/installation/uv.md b/docs/source/installation/uv.md index a14c0f5aa4..b31c9c8ba1 100644 --- a/docs/source/installation/uv.md +++ b/docs/source/installation/uv.md @@ -333,26 +333,26 @@ 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 +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 +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 +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 +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. +the pip package. :::