Commit graph

46 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
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
Jason Villanueva
32b714a898
Improved CLI help page styling (#1975)
* First draft of cloup/click update

* Added some customizability via cfg files

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

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

* Fixed test_command epilogs

* Adjusted logic for overriding theme

* Update main help page, no_args_is_help, and documentation

* Removed help shorthand '-h'

* Apply suggestions from code review

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

* Update poetry lock again, update DefaultGroup snippet

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>
Co-authored-by: Naveen M K <naveen521kk@gmail.com>
2022-04-24 10:05:23 +00:00
Bailey Powers
3413ca226f
Copyedited Documentation (#2640)
* Copyedited Documentation

Changelog / Overview
Reviewed tutorials\configurations.rst. Edited simple mistakes such as Manim not being capitalized and commas.

Motivation and Explanation: Why and how do your changes improve the library?
My motivation was to start getting involved in the open source community. This improves the library as it increases readability and professionalism.

Links to added or changed documentation pages

Further Information and Comments
Closes #1401

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

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

* Apply suggestions from code review

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Luca <30503695+tameTNT@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>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Luca <30503695+tameTNT@users.noreply.github.com>
2022-04-15 21:21:45 +00:00
Naveen M K
cddd47ca53
Remove WebGL renderer (#2630)
* Remove WebGL renderer

Fixes https://github.com/ManimCommunity/manim/issues/2629

* Remove occurence of webgl_renderer in CI config

* Fix Dockerfile

* Remove reference to webgl renderer in config docs

* Update poetry lock file

* Remove some scripts related to webgl

* Don't use rich 12.0 version

* Ignore rich 12.0.0

* Fix dependency, it was wrong previously
2022-03-24 08:39:24 +05:30
Darylgolden
ccfea0ff4a
Made improvements to the :doc:configuration tutorial (#2414)
* Attempt to use CI to update translations

* try again

* runs on ubuntu latest

* Try to fix

* again

* try to use PR branch

* that didn't work

* will this work?

* Revert "will this work?"

This reverts commit 1e6543a77f.

* Try a different action

* fix attempt

* another attempt

* Revert "another attempt"

This reverts commit 8965000ac3.

* try again

* automatically generate list of all flags

* remove unrelated change

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

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

* specify dep

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

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

* Update tutorial

Move CLI stuff to the top since it's the most important, slight rewrite, some copyediting

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

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

* slight rephrasing

* make underline long enough

* Revert "Merge branch 'main' into command-output"

This reverts commit e6a9d457d3, reversing
changes made to 3f0137a690.

* Revert "Revert "Merge branch 'main' into command-output""

This reverts commit c823c6eb8f.

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-01-06 14:31:22 +08:00
Evan Boehs
b04f0379f0
Copyedited the configuration tutorial in the documentation (#2131)
* Update configuration.rst

* 2 instances of may, one of might

Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-10-02 12:29:19 +08:00
Ryan McCauley
4831e1dc77
Add opengl support for --format png output
* Add png output support for opengl

* Handle when interactive embed should launch

* Handle when window should be created

* Remove unused import

* Remove confusing field

* Avoid creating window when any format is set

* Revert removing manim import

* Remove second log for interactive_embed

* Add force_window flag

* temp skip tests due to opengl context issue

* Fix context issue

* Try manually closing window in opengl tests

* Test disabling parallel runs

* Test disabling parallel runs

* Try clearing frame buffer on finish

* revert clear

* Skip tests that pass locally but fail windows CI

* Reenable opengl tests

* Remove stdin closed check

* Skip flakey test

* Stop window creation when save_last_frame is set

* Update config path

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>
2021-09-28 18:19:22 +01:00
Ryan McCauley
32eda9d66a
Add config to enable opengl wireframe (#2041) 2021-09-16 13:14:29 +00:00
Christopher Besch
ac803e607a
Corrected user-wide config paths for *NIX (#2020)
Tested config in `~/.config/manim/manim.cfg` and `~/config/manim/manim.cfg` on Debian.
The config in `config` doesn't work, while the one in `.config` does.
2021-09-06 15:01:43 +05:30
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
Laith Bahodi
044889e742
Add window_size flag. (#1760)
* Add window_size flag

* parse window_size in utils.py

* remove from str_keys

* messy fix...
2021-08-01 01:01:02 -04:00
Vinh H. Pham (Vincent)
ce7d67b109
update misleading -h flag in document (#1819) 2021-07-20 21:55:17 +08:00
Mohammad Al-Fetyani
13369e3ad5
Fix not being able to set some CLI flags in the configuration file (#1763)
* Default options to None

* Fix tests. transparent cannot be set in the config file

* Remove unused "png_mode" flag

* update
2021-07-09 06:33:08 -07:00
Laith Bahodi
32827aca73
Improve positioning and size of the OpenGL window. (#1728)
* add flags, vastly improved window positioning and size

* drop window_size flag, doesnt seem necessary

* fix weird formatting

* add error checking and full direction input for window_position

* use ValueError instead

* update docs, remove unnecssary code

* improve descriptions

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-07-02 13:09:57 +00:00
Mehmet Ali Özer
054d91544e
docs: Fix tip content of command-line arguments (#1620)
manim -h is not valid, Try 'manim render --help' for help.
2021-06-04 01:23:13 -07: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
199424d713
Remove $ from tutorial commands (#1445) 2021-05-03 10:47:23 +05:30
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
Naveen M K
7417fbc599
Blacken docs (#1323)
this hook will check formats in docs code blocks and format it using black
2021-04-13 11:57:27 +05:30
Ricky Chon
875f2d1f6d
Notify user if they are using an outdated version of Manim (#1237)
* Notify user if local version is outdated

Running the `manim` command will display the version number as green
if it is the latest detected on GitHub. Otherwise, display the version
number as red and let the user know that a newer version is available.

* Black formatting

* Add requests dependency

* Switch to PyPi API since it's not ratelimited

* Add CLI option for notifying local outdated build

Manim will notify user if local installation is outdated, after
rendering. This feature is enabled by default, but could be turned off
in config.

* Update notify_outdated_version instructions

* Please the flake

* Add documentation to configuration.rst

* Update poetry.lock

* Update option punctuation

* No need to inform users if they're up to date

* Move variable to within method

* Remove unused import

* Update dependencies

* Update outdated version message

* Run isort

* Fix typo

* Set `--notify_outdated_version` default to `None`

Flag value by default is None so config file will determine the value.
If flag is used then value is True.

* Convert CLRF to Unix newline LF (cleaner diffs)

* Remove argument check for outdated version

Too verbose, value should be configured via config

* Handle requests exceptions

* Update manim/cli/render/commands.py

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

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

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

* Use f-strings for logger warnings

* Update poetry.lock

* Update manim/cli/render/commands.py

Co-authored-by: KingWampy <9156604+WampyCakes@users.noreply.github.com>

* Update manim/cli/render/commands.py

Co-authored-by: KingWampy <9156604+WampyCakes@users.noreply.github.com>

* Move print statements within try block

* Except JSONDecodeError only

* Update manim/cli/render/commands.py

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

* Update manim/cli/render/commands.py

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

* Don't raise exceptions, log in debug

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: KingWampy <9156604+WampyCakes@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
2021-04-11 20:59:48 +05:30
Peilonrayz
b74ea538b2
Fix mean/meant typo (#1319) 2021-04-11 20:47:29 +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
Darylgolden
1d9fdaf629
New Feature: Added media_width option to the config to change the default width of gif+video output in Jupyter notebooks (#1074)
* Added new 3D mobjects: mostly taken from dor2727's previous incomplete PR

* Added Torus from 3b1b manim

* Added tests

* Remove personal test file

* Ran black

* Added test for Arrow3D

* Apply suggestions from code review

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

* Black formatting

* Added documentation, tests failing?

* Added documentation, tests fixed

* Rename self.height to self._height

* Removed unnecessary property.

* Fixed tests

* Apply suggestions from code review

Co-authored-by: friedkeenan <friedkeenan@protonmail.com>

* Black

* Apply suggestions from code review

Simple changes for now

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

* Apply suggestions from code review

Possibly breaking changes

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

* Update manim/mobject/three_dimensions.py

Fix indentation

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

* Update manim/mobject/three_dimensions.py

Fix indentation

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

* Fix things

* Change parameter names for Torus

* Added get_direction method for Cylinder and fixed direction setting

* retrigger checks

* Changed max-width to 375px

* Resolve merge conflict

* Attempted to add config for jupyter_width

* Apply suggestions from code review

Attempt to fix

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

* Fixed config

* Updated test data.

* Change name in cfg file to match ManimConfig

* Added media_width support to iPython Image

* Revert "Change name in cfg file to match ManimConfig"

This reverts commit 57080a91be.

* Revert "Added media_width support to iPython Image"

This reverts commit 0391bfb223.

* Revert "Revert "Change name in cfg file to match ManimConfig""

This reverts commit 7d499fa43c.

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: friedkeenan <friedkeenan@protonmail.com>
2021-03-21 23:21:28 +01:00
Devin Neal
83dd82b6d3 doctests 2021-03-06 15:50:20 -08:00
Devin Neal
448d10b590 Animate Arc with OpenGL 2021-02-19 20:41:01 -08:00
KingWampy
554f829848
Enhancement: Add manim version to CLI output, append version name for generated gif+png, add version to metadata of rendered videos (#984)
* Initial commit

* black formatting

* Changes

* Test to see if it works

* Changes

* Update manim_directive.py

* Update manim_directive.py

* Update manim_directive.py

* Update manim_directive.py

* Update scene_file_writer.py

* Always forget black..

* Change path separator

* Changes

* Add blank line in option block

* Update scene_file_writer.py

* Update metadata messages

* No longer add version to video names

* Fix test_dash_as_filename

* Update __init__.py
2021-02-10 16:56:05 +01:00
Devin Neal
57f228b8eb
Js tweening (#952)
* Add .animate attribute to mobjects

* Return function from _AnimationBuilder.__getattr__

* black

* Pass background color to JS renderer

* Handle default case

* Pass background color to JS renderer

* Remove line that came back in the merge

* Handle FrameServer case

* Use community colors by default

* Allow for chaining _AnimationBuilder

* Trying to do tweening

* Add _AnimationBuilder.build()

* Apply docs patch

* Pass tweening data

* Pass ID for ImageMobject

* Fix Wait bug, add FadeIn tween data

* Remove unused proto fields

* Remove unused proto field

* Optimize RPCs

* Handle frame skipping better

* Refactoring

* Ignore PreviewMode.ALL

* Remove preview mode

* Don't send tween data for wait

* Opacity fixes

* Add comments

* Simplify protos

* Add tween data for wait

* Add todo

* Serialize when updating

* Prepare to send tweened and non-tweened mobject IDs

* Pass updater information to javascript

* Add log

* Rename js_* -> webgl_*, remove WebGLScene

* rename js->webgl in workflow file

* Update doctest

* Update .gitattributes

* Remove try/except for webgl imports

* Step through animations using updaters with fixed frame rate

* Add --webgl_updater_fps flag

* Configuration test

* configuration test

* JS->WebGL

* Add install message
2021-01-29 08:33:49 -08:00
Naveen M K
65240b8bc8
Automatically Import Plugins (#967)
* Automatically import Plugins
Specify plugins using CLI and config file

Signed-off-by: Naveen M K <naveen@syrusdark.website>

* Fix Doc tests

* clean manim.cfg

* Add more explanatory docs

* add info about plugins site

* use property method

Co-authored-by: friedkeenan <friedkeenan@protonmail.com>

* use types module and f-strings

* Add tests

* lint

* remove --plugins
it seems it is not possible currently to implement that

* fix doc tests

* don't define unnecessary variables

* Apply suggestions from code review

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

Co-authored-by: friedkeenan <friedkeenan@protonmail.com>
Co-authored-by: Leo Torres <dleonardotn@gmail.com>
2021-01-28 20:57:27 +05:30
KingWampy
80574b7125
Make ManimCommunity look consistent (#971) 2021-01-28 15:05:08 +05:30
KingWampy
8fce5a74cb
New feature: Added --version command line flag (#970)
* Add --version commandline flag

* Update __init__.py

* Update manim/_config/main_utils.py

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

* Fix Black Check

* Update poetry.lock

* Create test_version.py

* Make black happy

Running black locally didn't catch this for some reason..

* Review changes

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-01-28 02:26:00 +01:00
kolibril13
691db1e461
Run proofreading over the whole library (#890) 2021-01-01 17:59:12 +01:00
kolibril13
5f1cfa3c9d
Added flowchart for Docs overview (#828)
* added flowchart

* updated flowchart

* added second flowchart
2020-12-05 21:26:55 +05:30
Jason Villanueva
a9321acd52
fixed test (#831) 2020-12-05 13:57:55 +01:00
Leo Torres
f3256087a3
Fix doctests (#797)
* fix doctests

* add doctest to our ci pipeline

* need test reqs

* skip rendering videos for the doctests

* try to fix doctests under windows

* shell=True only when running on windows

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2020-12-04 11:05:11 +01:00
Benjamin Hackl
6a02b38a2d
Fix docbuild warning (#744)
* fix all docbuild warnings

* black
2020-11-20 23:50:40 +01:00
Benjamin Hackl
e51d774078
Reorganize example gallery (#687)
* reorganize example gallery
* larger heading for example gallery page
* add references to gallery examples
2020-11-17 18:45:03 -05:00
Leo Torres
d0e04f8cc6
Document config system (#659)
* rename config subpkg to _config for the time being
* Revamp documentation for configuration system modules and classes.  Revamp tutorial.  Update changelog
* use as_posix so that doctests will pass on Windows
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2020-11-06 21:56:12 -05:00
leotrs
24b1a7fa26 update list of flags 2020-11-02 11:17:43 -05:00
Benjamin Hackl
9733d6ad42 fix warnings in docbuild 2020-10-12 19:30:00 +02:00
Julian van Doorn
d8dab7857d
Added explicit production quality flag. (#529)
* Added explicit production quality flag.

* Updated documentation to mention production quality flag.
2020-10-08 15:28:28 +02:00
Julian van Doorn
299e75631c
Merge branch 'master' into issue-511 2020-10-06 22:45:19 +02:00
Julian van Doorn
fa0a82c226
Implements -q[l|m|h|k] (#514)
Consolidates quality flags under a single --quality or -q flag
2020-10-06 13:42:52 -07:00
Julian van Doorn
f79948348c
Removed play_chord, play_error_sound and play_finish_sound functions. As a consequence sox has become a redundant dependency, thus it has been removed. 2020-10-06 21:50:10 +02:00
Leo Torres
b21c50493a
add docs reqs for RTD site, and update the output of 'manim --help' to fix doctests (#381) 2020-08-30 19:27:23 -04:00
Leo Torres
54854ccf23
Documenting the config system (#303)
* add output of manim -h to the documentation, as a poor man documentation of CLI arguments

* document config system and general changes in the description of each command line flag

* run black

* MacOS

* update

* Add configuration.rst back to the toctree. Add the contributing guidelines, which is just a symlink to the main repository\'s contributing.md file.

* add the symlinks

* fix length of underlines

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
2020-08-16 07:08:26 -04:00