Commit graph

162 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
Jeff Hanke
2bb793aef0
Fixed broken links in README (#2975)
* Fix broken links in README.md

- Fix the link to the description of the differences between 3b1b and community versions of manim. 
- Fix the link to the list of command-line arguments.

Fixes #2934

* Narrow README.md link to exact section.

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

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2022-10-03 00:04:55 +02:00
Darylgolden
3add3c21a9
Add note about contributions during refactor period (#2500)
* Note about contributions

* md link

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

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

* Fix typo

* improve phrasing

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-01-30 14:23:28 +00:00
Darylgolden
a781b303ed
Remove instructions for Docker on README (#2415) 2022-01-07 20:36:46 +08:00
Darylgolden
be8e16c6bc
Remove unintended line break (#2329)
Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>
2021-11-27 19:18:34 +00:00
Darylgolden
51a84032b5
Replace link to old notebook (#2287) 2021-11-12 06:48:08 +08:00
imadjamil
5ef6b53410
Fix broken link in readme (#2035)
* [README] fix broken link to poetry docs

* Update README.md

Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>

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

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

Co-authored-by: Jamil <ijamil@itron.com>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-09-11 21:46:04 +02: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
Darylgolden
454edecb8e
Add CITATION.cff and a method to automatically update this citation with new releases (#1964)
* Template + citation

* Add URL

* Update citation instructions

* Remove tags

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

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

* attempt to use entity object

* Update CITATION.cff

* Change title

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-08-30 22:56:14 +00:00
vladislav doster
df6a7cf6c1
Update README.md (#1906)
- make spacing around code fences consistent
- add missing `sh` language hint to code fences
- add `BibTex` language hint to citation code fence
- correct grammar
- remove trailing whitespace
- make header spacing consistent
2021-08-13 20:13:30 +02:00
Darylgolden
ed64149aa3
Updated installation instructions (#1807)
* Update installation section

* Indent

* Update admonition

* Update installation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-08-02 14:12:59 +08:00
PaulCMurdoch
723e645abc
Updated citation to Manim 0.9.0 (#1745)
* Updated citation to Manim 8

* Updated citation to Manim 9

Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-07-03 03:45:44 +00:00
Jason Villanueva
e9aa7d3696
Renamed instances of master to main (#1720) 2021-06-24 08:57:30 -07:00
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
Mark Miller
1f0c4a4c8a
Added a "How to Cite Manim" section to the Readme (#1425)
* add citation to README

* improvements to cite section in README

* add comment on referencing / citing manim to documentation landing page

* remove stray paragraph

* separator between manim and mathematical animation framework

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-05-01 13:35:56 +02:00
Elisha Hollander
e8788e8423
Grammar fixes (#1291) 2021-04-08 10:33:58 -07:00
Nidhal Baccouri
b412bf9d0b
Updated readme by providing the correct link to the example_scenes (#1284)
* updated readme

update the link to the "example_scenes" page

* fixed link to the the example_scenes

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-08 18:32:01 +02:00
kolibril13
2b6b2cddcc
Added example jupyter notebook into the examples folders (#1029)
* example notebook

* removed cell output

* added jupyter/ folder to gitignore

* added link to binder in documentation

* Update docs/source/installation.rst

* updated binder links in readme

* Update example_scenes/manim_jupyter_example.ipynb

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

* Update example_scenes/manim_jupyter_example.ipynb

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

* Update docs/source/installation.rst

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

* added config.media_width = "10vw"

* updated notebook to latest version

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-08 10:36:18 +02:00
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
Benjamin Hackl
a8a37882da
Updated Dockerfile (include dependencies for building documentation), moved documentation to main README (#1219)
* include docker/readme.md in main README.md + update contained information

* update dockerfile: more LaTeX dependencies, jedi workaround no longer needed, requirements for building documentation
2021-04-01 20:58:00 +02:00
Darylgolden
28abd477d7
Replace links to the latest version of the documentation to the stable version (#1177)
* Replace latest links with stable links

* Change link in PR template back to latest
2021-03-26 20:49:22 +01:00
Lionel Ray
39351b0202
Deprecation: Deprecated ShowCreation in favor of Create, added logger warning (#1124)
* Deprecated ShowCreation in favor of Create

* Fixed Black formatting and logger error

* Fixed relative import issue of logger

* Renamed CreateThen.. calls to previous names

* Fixed __all__ classes, fixed Create inheritance

* Update manim/animation/creation.py

Move logger warning to class initializer

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

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-03-23 16:13:59 +01:00
Benjamin Hackl
60c225a191
Enhancement (of new feature): JupyterLab docker image and documentation for manim and IPython (#977)
* fix import: move setting __version__ to top of __init__

* add simple Dockerfile for a manim-jupyterlab container

* add section on jupyterlab in docker/readme.md

* improve Dockerfile: separate user, install manim with all extras, upgrade to python 3.8

* remove separate jupyterlab docker image, adapt readme

* add missing latex package

* include link to interactive worksheet in documentation

* Update README.md

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-01-31 18:24:21 +01:00
Benjamin Hackl
b2abe699fb
New Feature: IPython %%manim magic (#943)
* working prototype of manim line and cell magic

* downgrade "dummy animation" log entry from warning to debug

* use built-in methods for displaying images/videos

* create tempconfig from current config, if available

* cleanup imports

* add some basic documentation and pointers

* make import of ipython_magic robust against missing IPython

* add statement to README

* fix link in quickstart

* experimental: stateful magic allowing to circumvent caching

* add jupyterlab to optional dependencies in pyproject.toml

* actually make jupyterlab an optional dependency

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

* try to improve the situation for google colab

* embed video within google colab

Co-authored-by: Naveen M K <naveen@syrusdark.website>
2021-01-28 13:36:23 +01:00
Jason Villanueva
2276cb059f
Added code of conduct (#935)
* Added code of conduct

* Added CoC to sphinx/README.md

* Shortened verbosity in  Enforcement Procedures

* Made conduct.rst a symlink

* Update CODE_OF_CONDUCT.md

* Update CODE_OF_CONDUCT.md

* Tweaked header section levels

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-01-18 19:14:57 +05:30
Jaime R
1655da47b8
Added blank line between imports and class example (#904)
Check PEP 8: E302
2021-01-03 23:19:25 +01:00
kolibril13
b227c91933
Change badges in ReadMe (#854)
* added twitter badget

* Update README.md

changed order

* Update README.md

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

* Update README.md

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

* Update README.md

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

* Update README.md

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

* Update README.md

documentation lowercase

Co-authored-by: Naveen M K <naveen@syrusdark.website>
2020-12-13 13:55:57 +01:00
kolibril13
c05ee3e63c
Add examples to animation creation (#820)
* added creation animation

* added further animation

* added further animation + docstring template

* added further examples

* black

* one more update

* one more update

* one more update

* one more update

* one more update become

* hope that this will fix the build

* Apply suggestions from code review

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* updated templates

* small fix

* tests

* Apply suggestions from code review

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

* Update README.md

* merged master and typo in README.md

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Leo Torres <dleonardotn@gmail.com>
2020-12-13 12:41:06 +01:00
Aron
247cdeecf6
Update Docs Url (#832)
* Changed manimce links in the docs to docs.manim.community, replaced manimce with manim where applicable

* black is extra finicky today

Co-authored-by: Aron Fischer <cobordism@github, co-bordism@gitlab>
2020-12-07 09:59:21 +05:30
kolibril13
7fe79e36ec
manimce to manim & capitalizing Manim in readme (#794) 2020-12-04 02:08:55 +01:00
KingWampy
eb6197ba54
Typo (#762)
Typo in the NOTE section of README
2020-11-22 23:19:33 +01:00
Benjamin Hackl
7a7e9cbd57
Bring back support for docker (#681)
* add first version of dockerfile and corresponding texlive.profile

* add reference to docker in the installation docs

* rename textlive.profile -> texlive-profile.txt

* newline at end of file

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

* remove libpango1.0-dev

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

* add docker badge to readme, fix links for badges

* let banner link to manim.community

* Fix broken link

* Docker images --> docker images

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2020-11-10 21:55:41 +01:00
Safin Singh
6addeccadf
Clean up README (#586)
* Clean up README

* update flags

* Apply suggestions from code review

* updated command.png

* removed redundant files from readme-asserts and used files from docs/_static instead

* change to relative parts

Co-authored-by: Leo Torres <leo@leotrs.com>
Co-authored-by: kolibril13 <jan-hendrik.mueller@gmx.net>
2020-11-10 13:28:50 +01:00
Devin Neal
524542cc35 Rename banner.png to cropped.png 2020-10-21 23:17:21 -07:00
Devin Neal
8add4d0326 Use png banner 2020-10-21 20:03:14 -07:00
Devin Neal
697775a37b Add banner to README 2020-10-21 19:48:09 -07:00
Devin Neal
5567fc42cb Rename logo files and update README 2020-10-21 19:32:11 -07:00
Devin Neal
009ab65d20
Update README.md 2020-10-21 18:05:40 -07:00
Naveen M K
88f8252b4b
Move to Poetry (#165)
* Add necessary files and fix readme

* remove poetry.lock

* Change some things

* Add Github action to Publish

* Specify rich version - updates in setup.py

* Add lock file

* Add some docs about poetry

* Add some docs and upgrade rich

* remove Setup.py

* Github Action using Poetry

* Fix tests

* Move to py 3.7 until poetry fixes it

* Remove 3.6

* Looks like 3.6 works now

* Fix Path for CI

* Windows build

* Add CI that actually works

* Fix some spaces

* Update docs and fix windows test

* Fix windows run

* Change some formatting -Docs

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* Some docs update

* Change doc url Pyproject - Some formatting docs - change ci on release event

* Change to manimlib

CC. https://github.com/ManimCommunity/manim/pull/165#discussion_r481128270

* Some formatting changes

* Merge branch 'master' of https://github.com/ManimCommunity/manim into poetry-change-new

* Remove pytest.ini and Have a note in Readme

* Update some docs

* Update Authors field

* Make readthedocs work

Co-authored-by: Leo Torres <dleonardotn@gmail.com>
2020-09-10 08:59:34 -04:00
CorvidCanine
6aeb52f622
Add manim import to example script in README.md (#410) 2020-09-03 19:46:14 -04:00
Leo Torres
aa561c027a
Make the README point to the RTD docs (#383)
Update readme to contain links the RTD docs. Move contributing.md to the docs.
2020-08-31 17:39:10 -04:00
Finite
e29b6276bb
fix links to basic.py, custom_template.tex and customtex.py in readme (#372) 2020-08-29 16:00:17 +02:00
CSylvain
704b63e614
Update README.md (#314)
add second example Scene generation and suggest use of CLI parameter `--media_dir` rather than environment variable
2020-08-17 07:44:15 -04:00
CSylvain
f65253fcd5
Update README.md
must reference "raw.github.com" to get the contents of `basic.py`, otherwise one gets the github file content page in HTML.
2020-08-15 17:37:09 +00:00
Philip Enchin
62ccdf509a Change pip3 package to community edition 2020-08-09 01:38:02 -04:00
Philip Enchin
3f6b9bf4ec
Remove toc entry that links to missing section (#239)
- Under Ubuntu/Debian installation instructions, there is no section
titled "Additional Installation Steps"
2020-08-02 20:55:05 +02:00
kilacoda
8cb0d9d08a
Replace Travis badge with GitHub Actions badge 2020-08-02 11:38:29 +05:30
aliPMPAINT
092dd72ea4
Add Manjaro/Arch 2020-06-15 15:15:04 +04:30
aliPMPAINT
61fbf8e502
Typos 2020-06-15 14:59:30 +04:30
aliPMPAINT
7cffb768ec
Clearing installation for linux 2020-06-15 14:57:34 +04:30