Commit graph

134 commits

Author SHA1 Message Date
Benjamin Hackl
33a0e56d73
enhancement: optimize Docker image build and runtime footprint (#4604)
* docker: add libgl1 runtime dependency for OpenGL

* docker: tighten .dockerignore for smaller build context

* docs(docker): add runtime notes for latest image

* docs(docker): note ctex is not included by default

---------

Co-authored-by: Francisco Manríquez Novoa <49853152+chopan050@users.noreply.github.com>
2026-02-22 17:29:18 -03:00
u7920349
cd370610c5
Documentation: manual installation of manim as a local package (#4456)
* Documentation: additonal instalation method

* Typo fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* docs: simplify dev-install section and restore PR template checklist

---------

Co-authored-by: CA3000 <93896083+CA3000@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2026-02-22 11:59:40 +01:00
Francisco Manríquez Novoa
0b3f28a5af
Revert "Set the default Python version to 3.13 in the uv installation guide (…" (#4534)
This reverts commit 83bcafb0e7.
2026-01-18 08:49:10 +01:00
Henrik Skov Midtiby
83bcafb0e7
Set the default Python version to 3.13 in the uv installation guide (#4480)
* Set the default python version to 3.13 in the uv installation guide.

* Capitalize Python

---------

Co-authored-by: Francisco Manríquez Novoa <49853152+chopan050@users.noreply.github.com>
2025-11-19 19:12:11 +00:00
Benjamin Hackl
9479febef2
docs: add explicit instructions for installing pkg-config and cairo as required by pycairo for macos (#4146) 2025-02-10 20:52:36 +01:00
Aarush Deshpande
953888e68e
Rewrite installation instructions (#3930)
Follow-up to #3501

This commit combines all the installation documentation onto one page, and switches to recommending the usage
of `uv` for installing Manim.
2024-12-06 18:50:18 -05:00
CJ Lee
b064af9abb
Update macos.rst (#3857)
* Update macos.rst

As of July/2024, brew installs Manim and its dependencies.
Guideline for installing dependencies with brew, and attempt to install using pip3 will no longer work either venv or not.
Now homebrew team manages python resources as "System-wide" only with Brew installed resources. 
Hence, to give first time installer just leave a single line install command would be the simplest option we have.

* Update docs/source/installation/macos.rst

---------

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2024-07-14 12:00:08 +00:00
Benjamin Hackl
1f249e45b9
Let SceneFileWriter access ffmpeg via av instead of via external process (#3501)
* added av as a dependency

* make partial movie files use av instead of piping to external ffmpeg

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* opengl rendering: use av for movie files

* no need to check for ffmpeg executable

* refactor: *_movie_pipe -> *_partial_movie_stream

* improve (oneline) documentation

* pass more options to partial movie file rendering

* move ffmpeg verbosity settings to config; renamed option dict

* replaced call to ffmpeg in combine_files by using av

Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* there was one examples saved as a gif?

* chore(deps): re-order av

* chore(lib): simplify `write_frame` method

Reduces the overall code complexity

* chore(lib): add audio

* fix(lib): same issue for conversion

* fix(lib): webm export

* fix(lib): transparent export

Though the output video is weird

* try(lib): fix gif + TODOs

* chore(deps): lower dep crit

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* feat(lib): add support for GIF

* fix(ci): rewrite tests

* fix

* chore(ci): prevent calling concat on empty list

* add missing dot

* fix(ci): update frame comparison ?

* fix(log): add handler to libav logger

* chore: add TODO

* fix(lib): concat issue

* Revert "fix(ci): update frame comparison ?"

This reverts commit 904cfb46ae.

* fix(ci): make it pass tests

* chore(lib/docs/ci): remove FFMPEG entirely

This removes any reference to FFMPEG, except in translation files

* added av as a dependency

* make partial movie files use av instead of piping to external ffmpeg

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* opengl rendering: use av for movie files

* no need to check for ffmpeg executable

* refactor: *_movie_pipe -> *_partial_movie_stream

* improve (oneline) documentation

* pass more options to partial movie file rendering

* move ffmpeg verbosity settings to config; renamed option dict

* replaced call to ffmpeg in combine_files by using av

Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* there was one examples saved as a gif?

* chore(deps): re-order av

* chore(lib): simplify `write_frame` method

Reduces the overall code complexity

* chore(lib): add audio

* fix(lib): same issue for conversion

* fix(lib): webm export

* fix(lib): transparent export

Though the output video is weird

* try(lib): fix gif + TODOs

* chore(deps): lower dep crit

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* feat(lib): add support for GIF

* fix(ci): rewrite tests

* fix

* chore(ci): prevent calling concat on empty list

* add missing dot

* fix(ci): update frame comparison ?

* fix(log): add handler to libav logger

* chore: add TODO

* fix(lib): concat issue

* Revert "fix(ci): update frame comparison ?"

This reverts commit 904cfb46ae.

* fix(ci): make it pass tests

* chore(lib/docs/ci): remove FFMPEG entirely

This removes any reference to FFMPEG, except in translation files

* chore(deps): update lockfile

* chore(lib): rewrite ffprobe

* fix typo

* slightly more aggressive removal of ffmpeg in docs; minor language changes

* fix gif output stream dimensions

* minor style change

* fix encoding of (transparent) mov files

* fixed metadata / comment

* set frame rate for --format=gif in output_stream

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more video tests for different render settings, also test pix_fmt

* improve default bitrate setting via crf

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* parametrized format/transparency rendering test

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* context managers for (some) av.open

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update manim/utils/commands.py

Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>

* fixed segfault

* update test data involving implicit functions (output improved!)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* explicity set pix_fmt for transparent webms

* special-special case extracting frame from vp9-encoded file with transparency

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix transparent gifs, more special casing in parametrized video format test

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* run tests on macos-latest again

* removed old control data

* Revert "run tests on macos-latest again"

This reverts commit f50efa4b88.

* added sound to codec test; fixed issue with sound track in gif (disabled) and webm (now via opus)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* manual wav -> ogg transcoding

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fixed f-string

* refactored codec test, split out gif

* check for non-zero audio samples

* more cleanup

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove ffmpeg from readthedocs apt_packages

* round up run_time if positive and shorter than current frame rate

* added more run_time tests

* black

* improve implementation of test

* removed some unused imports

* improve wording of logged warning

Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>

* move run_time checks from Animation.begin to Scene.get_run_time

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove unused import

* flake: PT012

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>
2024-05-15 13:23:09 +00:00
Pavel Zwerschke
2a4c2da1d7
Mention pixi in installation guide (#3678)
* Mention pixi in installation guide

* Update docs/source/installation/conda.rst

Co-authored-by: adeshpande <110117391+JasonGrace2282@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Add note

---------

Co-authored-by: adeshpande <110117391+JasonGrace2282@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2024-04-14 11:56:25 +00:00
Abulafia
77d42d2a46
Update jupyter.rst (#3630)
Pinpoint IPython==8.21.0 for Google Colab, because more recent versions are incompatible with their runtime.
2024-02-24 00:08:47 +01:00
NotWearingPants
f8b5066899
Update docker.rst to use bash from the PATH (#3582) 2024-01-25 00:41:38 +01:00
Adhyyan Sekhsaria
e84547f36d
Update dependencies for apple silicon in macos.rst (#3290)
According to https://pypi.org/project/ManimPango/
manim pango also needs pkg-config
2023-07-16 10:18:01 +02:00
Benjamin Hackl
a3b1d9f2ff
replace mentions of Python 3.7 as the minimally required version with 3.8 (#3274) 2023-07-05 00:02:11 +09:00
Sujal Singh
96eba4ca2c
add latex installation instructions for fedora (#3251)
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2023-06-20 09:18:14 +02:00
ItIsJoeyG
04e41a2e16
Changed winget install MiKTeX command (#3199)
In the docs the winget command to install MiKTeX was changed from `winget install ChristianSchenk.MiKTeX` to `winget install MiKTeX.MiKTeX`. I have changed the docs to reflect this change. Here is the link to the manifest on the winget repo. I have also attached an image that shows the original command not working and an image of the new command working.

Winget Repo Link: https://github.com/microsoft/winget-pkgs/tree/master/manifests/m/MiKTeX/MiKTeX
New command working: https://imgur.com/D7qp6kU
Image of old command not working: https://imgur.com/k7Pvpp0
2023-03-31 22:55:48 +02:00
Benjamin Hackl
59b78c27b6
linux installation instructions: minor language improvement / specification 2022-11-29 15:51:38 +01:00
Kevin Lubick
5bc4bc072c
Add Debian dependencies required for pycairo and manimpango (#3044)
Without these packages, using `poetry install` fails on pycairo and manimpango because there is no C++ compiler nor headers to compile parts of those packages.
2022-11-29 14:22:08 +01:00
Ievgen Pyrogov
da7d453c8c
Include ubuntu/latex install instructions (#3035) 2022-11-25 13:35:21 +00:00
Benjamin Hackl
7514e4a7b4
added one asterisk to make section underline long enough (#3004) 2022-10-28 16:49:30 +02:00
Nick Skriloff
c96b95722b
Added installation instructions for Windows via `winget` (#2936)
* Update windows.rst

* added winget installation of MiKTeX from other PR, closes #2937

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2022-09-24 16:15:08 +02:00
Pavel Zwerschke
63cc40120d
Add conda installation docs (#2914)
* Add conda installation docs

* MacOS -> macOS

* Add Working with Manim section

* Small fixes

* maybe the refs work now?

* why is ci stuck?

* Lets see if this works...

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen521kk@gmail.com>
2022-08-31 13:11:34 +00:00
Francesco Frassinelli
fba3b5e1f3
polish: Add implicit docker.io/ URL base (#2855)
* Add implicit docker.io/ URL base

* Fix double-column typo
2022-07-04 21:29:05 +02:00
ad_chaos
8dee0c2ded
Remove cmake (#2760) 2022-06-13 13:14:42 +02:00
Benjamin Hackl
48747a74d9
Refactored structure of documentation; added :doc:FAQ section <faq/index> (#2732)
* move tutorials -> tutorials_guide

* change title in tutorials_guides

* rename: a_deeper_look -> output_and_config

* splitting Tutorials

* reorder index (sidebar), move some top level sections elsewhere

* rename some tutorials

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* replace recommonmark with rest for rendering md files

* fixed broken references

* fixed **all** warnings and errors during docbuild

* faq: help, more structure for landing page

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix deprecation tests

* prepare some sort of skeleton for installation faq

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* ensure that pip from poetry venv is used in pipeline

* added myst-parser as dev dependency

* remove fixed sphinx version from requirement.txt, don't re-install dependencies

* move and improve versions and troubleshooting content to FAQ

* resolve broken references

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* help blacken-docs

* new: navigating the docs

* make different versions question more prominent

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fixed order of tutorials

* added explicit references to building blocks and quickstart tutorial

* docs -> doc

* change a page-reference to a paragraph-reference

* pypi manimlib, split answer regarding chocolatey failing

* added a note on #beginner-resources

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-05-27 08:45:31 +00:00
peaceheis
e648d88510
Copy Edit troubleshooting.rst (#2609)
* Copy Edit troubleshooting.rst

This is for Issue #1401.

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Update troubleshooting.rst

* Update troubleshooting.rst

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
2022-04-02 10:20:27 +08:00
Benjamin Hackl
a8de354101
Reduced the number of warnings during documentation build (#2603)
* use :pr: directive in changelog script

* change hardcoded links to PRs + issues to extlinks

* adapt extlink formatting

* fixed warning about bullet list

* improved formatting of an admonition, tried to fix section not expected (unsuccessful)
2022-03-08 12:23:27 +08:00
Kiran-Raj-Dev
e577bb6957
Updated minimal latex installation instructions (#2495)
* updated minimal latex installation instructions

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-01-30 14:41:12 +00:00
Laith Bahodi
00f0134027
Update Dependencies for Python3.10 (#2376)
* Update python dependency

* Update python version in the docs

* add python 3.10 to workflow

* use quotes for python version

* small mistake

* added cleo dependency

* added tomlkit

* using new installer for poetry

* updated path

* Update ci.yml

* changed path update

* added poetry to path, EVERYWHERE

* using pip now

* adding to path...again

* adding to path everywhere again

* fixed path, fingers crossed

* path only for macos

* bashrc?

* test path

* githbu path?

* github path, this time?

* updated grpcio; substituted * notation

* pre-commit update

* updated psutil

* importlib-metadata only for Python 3.7

Co-authored-by: Naveen M K <naveen521kk@gmail.com>

* remove pygments doubling

* added psutil-wheels

* removed psutil

* Update pyproject.toml

Co-authored-by: Marcin Serwin <marcin.serwin0@protonmail.com>

* ran poetry update

* Update pyproject.toml

Co-authored-by: Marcin Serwin <marcin.serwin0@protonmail.com>

* poetry upadated

* updated mypy version

Co-authored-by: Christopher Besch <christopher.besch@gmx.de>
Co-authored-by: Naveen M K <naveen521kk@gmail.com>
Co-authored-by: Marcin Serwin <marcin.serwin0@protonmail.com>
2022-01-11 16:17:55 +05:30
Matt Gleich
b4c5fa5556
docs: switch to mactex-no-gui from mactex (#2423)
Signed-off-by: Matt Gleich <git@mattglei.ch>
2022-01-05 09:04:05 +01:00
Kian Kasad
86c9f69ad3
Add 'collection-basic' to list of required LaTeX packages on Linux (#2371)
This adds 'collection-basic' to the list of LaTeX packages on the Linux
installatioon documentation page:
docs/source/installation/linux.rst

Several packages provided by 'collection-basic' are required for Manim
to function, so the whole collection is specified rather than finding
the specific packages.
2021-12-31 01:29:01 +00:00
Marcin Serwin
0757579460
Add documentation for growing animations (#2340)
* Make point_color a positional argument in all growing animations

* Replace arc path in SpinInFromNothing with spiral path

* Add docstring to growing animations

* Fix errors reported by sphinx

* Update tests

Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-12-02 13:48:38 +00:00
Lucas Ricci
18a0ef504b
Clarified that Manim does not support Python 3.10 yet in the documentation (#2310)
* warn that manim doesn't support python 3.10 yet added

* warning that manim does not support python 3.10 yet, was added

* changed the warning to a separate paragraph and rephrased it

* a few typo corrections, I also changed the other files that were was saying that manim supports python 3.7+, when actually is just 3.7-3.9

* Changed normal hyphens (-) to en dashes (–), and remove a space before and after a dash.
2021-11-20 15:56:19 +08:00
Anima
4ff2cbec1a
Transferred troubleshooting installation related snippets from Discord to the documentation (#2130)
* Added troubleshooting snippets from the Discord

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed linting errors

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed formatting issues

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Added requested changes

* added reference to the stack exchange post

* fixed link displaying incorrectly

* Mentioned which aliases caused the issue

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Moved atributation for PATH, broke up some lines

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Removed the copied answer for PATH

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Update docs/source/installation/troubleshooting.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-10-10 04:27:03 +00:00
GameDungeon
94821c10d8
Flake8 Changes + Fixing Warnings (#1968)
* Warning Removal

* Flake Stuff

* HotFix

* Docs Fix

* I'm Dumb

* Docs Fix 2

* Fixing Github Requests

* Fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* quick fix

* Add Deprecation Warning

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Weird Pre Commit Stuff

* Quick Fix

* Quick Fix

* Fix

* Flake Fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-09-03 13:45:48 -04:00
Benjamin Hackl
89bcec8f2f
Reworked installation instructions (#1949)
* move plugins

* plugins in main sidebar

* restructure installation guide

* fix some removed references

* more sphinx fixes

* restructured developer installation, more cleanup

* rename some files

* rewrote MacOS installation instructions

* rewrote the windows installation guide

* cleaned up linux installation instructions

* added a lot of colons

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* improve first paragraph of installation.rst

* move docker and jupyter to separate files

* Copyediting

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* change wording regarding colab env

* copyediting, second pass

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* first mention recommended ffmpeg installation for windows

* move admonition above table of contents

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-08-28 12:50:29 +00:00
Rohan Sharma
136d0cf532
Fix wording problem in colab installation docs (#1915)
* docs: fix wording problem in colab installation docs

* docs: add link to colab
2021-08-15 12:14:42 +08:00
Benjamin Hackl
c00eb0978c
Bump version number to `v0.9.0` and generate changelog (#1850)
* bump version number to v0.9.0

* changelog for v0.9.0, first pass

* v0.9.0 changelog, second pass

* try to take care of codespell

* v0.9.0 changelog, third pass

* v0.9.0 changelog, fourth pass

* fix some docbuild warnings

* v0.9.0 changelog, final pass
2021-08-02 12:07:57 +02:00
Kadatatlu Kishore
fbde9a145a
Update documentation for developer installation in for_dev.rst (#1842)
* Update for_dev.rst

* Update for_dev.rst

* Update for_dev.rst

* Update for_dev.rst

* Update for_dev.rst

* Update for_dev.rst

* Update for_dev.rst
2021-07-29 18:21:17 +02:00
Laith Bahodi
904696294b
switch order of scoop and choco (#1829)
Co-authored-by: KingWampy <9156604+WampyCakes@users.noreply.github.com>
2021-07-25 16:41:43 -04:00
ccn
df758a2e5e
Edited the developer installation instructions to add in missing context about repository cloning (#1743)
* Add in missing context about repo cloning

* added a link to existing git instructions

* Apply suggestions from code review

Co-authored-by: Darylgolden <darylgolden@gmail.com>

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-07-07 19:29:35 +08:00
Naveen M K
efd089ea39
docs: remove reference of --plugins (#1732)
`--plugins` flag isn't implemented but it was mentioned in the
documentation. I have removed it.
2021-06-30 23:04:06 +00:00
Iced-Tea3
a8d8c18e01
Added example to Colab installation documentation (#1659)
* Added Example to Colab Installation

* Included manim import

* Update docs/source/installation/colab.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-06-09 14:24:00 +08:00
Nikhil Garuda
05e4556381
Copyedited Documentation (#1509)
* Finished copyedititng

* Made some more changes

* Update plugins.rst

* Fixed scoop link

* Capped the character limit to 80

* Declare *.npz *.wav *.png as binary (#1560)

* Revert "Capped the character limit to 80"

This reverts commit c7e57faea5.

* Capped the character limit to 80 again

* Made it small r

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-05-26 17:52:09 +08:00
Skaft
60a775714e
Adding spell checker as a pre-commit hook (#1544)
* adding codespell precommit hook

* adding codespell config file

* fixing typos

* tweaking variable names to please codespell
2021-05-21 15:43:31 +05:30
Skaft
40bfc27dd2
Fixing broken links and other minor doc things (#1541)
* fix typos

* lowercasing note admonition

* fixing broken links

* fixing title underlines being too short
2021-05-19 05:56:32 -05:00
Darylgolden
2aaec7ab31
Update troubleshooting docs (#1508)
* Update troubleshooting

* link in installation docs

* change section header

* textmobject -> text and texmobject -> tex

* note

* Fix formatting

* formatting

* formatting

* section

Co-authored-by: Philipp Imhof <52650214+PhilippImhof@users.noreply.github.com>
2021-05-14 19:44:23 +05:30
Nikhil Sharma
488a177df1
Updated Discord links in the docs to point towards a standardized redirect (#1499)
* Update README.md

* updated discord links
2021-05-13 02:02:35 +02:00
Raghav Goel
7737c660ef
Added Scoop installation docs (Windows) (#1440)
* fix BulletedList alignment problem

* add typing for get_module

* flippin black

* ahh black stupidly showing only one file error in the action logs.... as usual

* fix -s issue

* fix -a path issue

* Revert "fix -a path issue"

This reverts commit 44b0cc1433. Already
fixed in ManimCommunity#1134

* remove remnant of ManimCommunity/manim#1120

* Revert 675324a

* Remove extraneous whitespace

How did this slip in here again..? Anyways, done to bring local fork in line with upstream.

* Make FILE a required argument

* add scoop installation docs
2021-05-12 10:26:29 +02:00
Skaft
bbe113e7d3
Fixing broken doc links (#1457)
* fix broken links

* fix typo
2021-05-03 21:13:51 +05:30
Benjamin Hackl
7f17ea6d24
Fixed all current docbuild warnings (#1424)
* fix all current docbuild warnings

* Rerun rtd

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-29 19:04:08 -07:00