Commit graph

124 commits

Author SHA1 Message Date
Darylgolden
6018ebf445 Revert "Merge branch 'main' of https://github.com/ManimCommunity/manim"
This reverts commit e7f9d23aa7, reversing
changes made to afe91d02b6.
2023-07-31 15:29:39 +08: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
Nikhil Garuda
7c8c1cb1d9
Grammatical error corrections in documentation (#1360)
* Grammatical error correction of docs

* Update contributing.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update for_dev.rst

* Update docs/source/installation/for_dev.rst

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

* Update plugins.rst

* Update reporting_bugs.rst

* Update a_deeper_look.rst

* Update configuration.rst

* Update quickstart.rst

* Update building_blocks.rst

* Update testing.rst

* Update testing.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update quickstart.rst

* Update quickstart.rst

* Update development.rst

* Update development.rst

* Update versions.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update building_blocks.rst

* Change of complier and output format in
 "InCodeTexTemplate" to the defaults

* Reverted back

* Change of Complier and Output format

The Complier and Output format of class InCodeTexTemplate has been changed to the defaults (latex and .dvi)

* Update customtex.py

* Update building_blocks.rst

* Update building_blocks.rst

* Update a_deeper_look.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: kilacoda <65204531+kilacoda@users.noreply.github.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-19 15:44:32 -07:00
Darylgolden
45afef3ce4
Added documentation explaining the differences between manim versions (#1268)
* Added documentation explaining the differences between manim versions

* Attempt to fix link

* Attempt to fix link again

* Attempt to fix link yet again

* Attempt to fix more links

* more fix attempts

* Apply suggestions from code review

Co-authored-by: Oliver <44864613+PhotonSpheres@users.noreply.github.com>

* Uncapitalized Manim

* fix

* Add link to manimgl documentation

* make names of different manim versions (more) consistent

Co-authored-by: Oliver <44864613+PhotonSpheres@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-07 20:44:28 +02:00
Ricky Chon
ace2bda445
CI: Fix macOS pipeline failure (#1255)
* Possible fix for macOS pipeline failure

* Revert back to --cask flag

* Remove cask command

* Remove cleanup command

* Revert "Remove cleanup command"

This reverts commit 63f59be5c9.

* Combine brew install statements

* Add --reinstall flag to tlmgr install just in case

* Fix typo

* Isolate dvisvgm.x86_64-darwin installation

* Remove dvisvgm.x86_64-darwin dependency

* Remove legacy dvisvgm package from mac install

* Remove brew update cmd and tlgmr --reinstall flag

Could improve build speed

* Bring back brew update but only upgrade basictex

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-05 01:48:59 -07:00
sparshg
64cbcd5256
Add TinyTex installation instructions (#1239)
* Add TinyTex installation instructions

* Update linux.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-02 22:53:14 +05:30
Jason Villanueva
a87bb28484
Refactored the Command Line Interface to use Click + Cloup instead of Argparse (#1013)
* Added click dependency and command structure

* Refactored code for separation of concerns

* Shortened plugins command to plugin, added render options

* first draft for render -h

* First successful render using click

* Cleaned main

* Moved flush_cache to option, ran black

* Removed argparse logic, scattered print statements

* corrected tests, all passing

* merge upstream

* fixed test with click's clirunner

* Fixed doctest configuration.rst

* Temporarily add in main_utils

* Removed main_utils.parse_args, used ManimConfig.digest_args

* fixed progress bar

* Fix jupyter

* black

* Fixed incorrectly merged merge conflict

* updated README command.png image

* updated configuration.rst expected output

* Fixed test_plugins and config_file expected type

* Refixed the jupyter fix

* Apply 3/5 suggestions

Remove stray print

Improve readability of test code

Added module docs for the subcommands

* Updated `main` to `manim` for tests

* Forced `file` positional argument to be Path type

* Fixed main -> manim

* Added libpango to linux dependency

* Updated poetry.lock

* Changed configuration.rst test

* Fixed test_a_flag test

minor space issue

added media_width to configuration.rst

* Fixed fps flag in Cairo rendering

* Fixed more outdated rst in sphinx docs

Removed default for fps option, always overwrote quality

Fixed doctest control_data

* Fixed more incorrect rst orderings

* Update tests/test_commands.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Added suggestions

* Removed unused imports

* Reverted entry point back to main

* Update manim/_config/default.cfg

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

* Adjusted ipython_magic's call to the entry_point

* Converted frame_rate to int if integer

* run black

* Fixed doctest

* Fixed issue with command name from CliRunner

* Fixed multiple video windows opening from upstream merge

* to black or not to black

* Added deprecation warning to render subcommand

* warning instead of warn

* Applied Naveen's suggestions

* Made `manim render` show the help page

* Update manim/cli/render/commands.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update manim/cli/cfg/commands.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update manim/cli/cfg/commands.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update manim/cli/plugins/commands.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Addressed some style changes

* add back in write_to_movie temporarily for OpenGL support

* Removed sound flag, deprecated use_opengl_renderer, added renderer option

* revert webgl_renderer_path removal

* Fixed cfg export

Fixed readme usage of CLI

* Flake8/black

* Fixed bug in setting renderer choice

* Removed log message due to default option

Removed default option of background color

Fixed write_to_movie flag default

* Fix log_to_file tests

* Make '-c' option for config_file, not background_color

* print colored version always

* Remove -v = --version shorthand, conflicts with verbosity

* Use subprocess.run instead of Click's CliRunner for stdout

* Refactor cli/render to use Cloup instead of click-option-group

1) There's a new file for each option group
2) render is now a cloup.Command, not a Group

Fixed issue when an animation is cached, manim can't merge the partial movie files. (#1192)

* fixed issue

* fixed tests

* Update manim/renderer/cairo_renderer.py

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

* added tests

* imrpoved test

* fixed logic

* added new test

* check if the file has been outputed

* added test when caching is enabled

* fixed tests on windows

* black

* Update manim/renderer/cairo_renderer.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update tests/assert_utils.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

Co-authored-by: KingWampy <9156604+WampyCakes@users.noreply.github.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>

Added :ref_methods: to the manim directive (#1209)

* fix manim_directive for methods

* added ref_methods to Angle example

* black

* added new ref_methods references

* sort out ref_functions vs ref_methods in examples.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Fixed issue when an animation is cached, manim can't merge the partial movie files. (#1192)

* fixed issue

* fixed tests

* Update manim/renderer/cairo_renderer.py

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

* added tests

* imrpoved test

* fixed logic

* added new test

* check if the file has been outputed

* added test when caching is enabled

* fixed tests on windows

* black

* Update manim/renderer/cairo_renderer.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update tests/assert_utils.py

Co-authored-by: Naveen M K <naveen@syrusdark.website>

Co-authored-by: KingWampy <9156604+WampyCakes@users.noreply.github.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>

Added :ref_methods: to the manim directive (#1209)

* fix manim_directive for methods

* added ref_methods to Angle example

* black

* added new ref_methods references

* sort out ref_functions vs ref_methods in examples.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Fixed unnecessary args dict

* Fixed bug that changed caching hashing result

* Revert doctest logic for fps filename output

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Gianluca Gippetto <gianluca.gippetto@gmail.com>
2021-04-01 23:53:07 -07:00
Jason Villanueva
e384ce93f2
Added testing/documentation from GitHub Wiki to Sphinx Docs (#1137)
* Added precommit for black, updated contributing documentation

Updated contributing.rst and related files

Fixed some grammar, added pre-commit section

* picked pre-commit version, removed redundant language_version

* Fix section headings

* Added GitHub testing/doc Wiki pages to docs

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Fixed some relative links

* Fixed flake8 issue

* Apply suggestions from code review

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

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-03-31 02:23:38 -07:00
Jason Villanueva
54ead3b61f
Added pre-commit to run black and flake8, updated contributing documentation accordingly (#1130)
* Added precommit for black, updated contributing documentation

Updated contributing.rst and related files

Fixed some grammar, added pre-commit section

* picked pre-commit version, removed redundant language_version

* Fix section headings

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Add in missing flake stuff to lock

* Added flake8 to pre-commit

* added newlines at the end of .flake8 and .pre-commit-config.yaml

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Apply suggestions from code review

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

* Reorder mentioning of tests after writing code

* Removed extra -

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-03-30 14:33:59 +05:30
Darylgolden
71a05e82b9
Added documentation for installing Manim on Colab (#1165)
* Flake8 fix

* Revert "Flake8 fix"

This reverts commit fc1a083be5.

* Add documentation for installing manim on colab

* Update docs/source/installation/colab.rst

* Fixed installation documentation

* Fix installation instructions

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-03-27 10:24:43 +01:00
Bogdan Stăncescu
2f4ade6285
Docs: Added code example to Mobject.get_critical_point(), fixed some broken formatting, added some links to installation guides (#1077)
* +doc Mobject.get_critical_point()

* Minor fix for minor doc improvement

* Minor indentation fix

* A few additional, minor doc improvements

* Update docs/source/installation/for_dev.rst

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

* fix broken link to contributing guide

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-03-23 00:52:57 +01:00
Naveen M K
7db6c7f730
docs: update installation docs for linux - pango (#1060)
* Linux users should install Pango also

see https://github.com/ManimCommunity/ManimPango/issues/27
manylinux wheels are to be removed in next release on ManimPango

* Add changes to Docker also

* don't mix tabs and spaces
2021-02-28 10:03:03 +01:00