Commit graph

436 commits

Author SHA1 Message Date
Nikhil Garuda
e36618a04d
Fixed the typo for Admonitions (#1551) 2021-05-21 15:35:13 +02:00
Nikhil Garuda
6a3be2797d
Restructuring of Contribution Section (#1550)
* Added Docstrings

* Added Examples

* Added references

* Added Typings

* Added Adominations

* Made some more changes for docs to work

* Fixed spelling mistake
2021-05-21 14:13:35 +02: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
Anton Ballmaier
15261ea65b
Fading module enhancements (#1454)
* finish draft implementation
* use @wrapss to remove docs problems
* reduce complexity and add doc deprecation
* Docs deprecated_params
* add decoratos to __init__
* Add decorators to documentation
* Finish detailed docs
* Apply suggestions from code review
Co-authored-by: Naveen M K <naveen@syrusdark.website>

* change since/until/message param docs
* Mark get_callable_info and deprecation_text_component as private
* change how until is included in warning messages
* Add The to parameter descriptions
* make params docs more readable
* make redirections docs clearer
* update dependency list
* order dependencies
* update examples
* fix dependency problem
* fix duplicate problem
* change decorator version
* updated lock file
* enhance function / method separation
* fix typo and double underscores
* rename message_ and replacement_
* Change warning to custom admonition
* remove [] as default parameters
* Remove "" around type
* fix bug and move to inspect
* doc string => docstring
* rename to deprecate
* change module docstring
* change to deprecation.py
* remove tests again
* Rename decorators.py to deprecate.py
* Update poetry.lock
* Test if deprecated class outputs the correct warning when used
* Rename deprecate to deprecation
* Shorten conditional for msg, since, util
* Specify decorator arguments in test
* Add tests for since and until as arguments
* Add test for msg argument for class
* Add test for replacement argument for class
* Remove unneeded docstring in deprecated class
* Add test for deprecate method, no args
* Update docstring examples, move deprecated method outside class
* Add test for method in class, since and message args
* Add test for deprecating nested class
* Add test for deprecated method in nested class
* Test deprecation of nested function
* Test param deprecation, only params argument
* Test deprecation of single method param
* Rename single param test method name
* Fix deprecated_params docstring whitespace
* Test parameter redirection using tuple
* Update warning msgs in deprecated_params docstring
* Test parameter redirection using lambda function
* Test param redirection from many to one
* Test param redirection from one to many
* Update Top.foo to deprecate with message
* FadeIn & FadeOut overhaul and deprecations
* Adjust examples
* Add docs
* Add simple example
* handle empty docstrings
* Update poetry.lock
* Deprecate ShowCreation using decorator to test the docs
* Test docstrings
* add examples
* Update example_scenes/basic.py

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Ricky Chon <rickychon99@gmail.com>
Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>
2021-05-15 16:23:47 +02: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
Nikhil Garuda
c82f84ce7d
Update of rate_functions (#1486)
* Added a new image

* Updated the example and deleted the static image.

* Update rate_functions.py

* Update rate_functions.py

* Apply suggestions from code review

Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-12 15:17:06 +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
Anton Ballmaier
71b86d5dfa
Deprecation Decorators (#1404)
* test

* revert test changes

* finish draft implementation

* use @wrapss to remove docs problems

* reduce complexity and add doc deprecation

* Docs deprecated_params

* add decoratos to __init__

* Add decorators to documentation

* Finish detailed docs

* [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: Naveen M K <naveen@syrusdark.website>

* change since/until/message param docs

* Mark get_callable_info and deprecation_text_component as private

* change how until is included in warning messages

* Add The to prameter descriptions

* is deprecated => has been deprecated

* Fix typo

* fix typo

* make params docs more readable

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

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

* make redirections docs clearer

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

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

* Fix typo

* fix typo

* fix typo

* is_are => has_have_been

* fix typo
(at this point I am questioning my ability to type prameter)

* update deprendency list

* order dependencies

* update examples

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

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

* fix dependeny problem

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

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

* fix duplicate problem

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

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

* change decorator version

* updated lock file

* enhance function / method separation

* fix typo and double underscores

* rename message_ and replacement_

* Change warning to custom admonition

* remove [] as default parameters

* Remove "" around type

* fix typo

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

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

* fix bug and move to inspect

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

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

* doc string => docstring

* rename to deprecate

* change module docstring

* change to deprecation.py

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

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

* some sugesstions

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

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

* remove tests again

* Rename decorators.py to deprecate.py

* Update poetry.lock

* Test if deprecated class outputs the correct warning when used

* Rename deprecate to deprecation

* Fix typos

* Shorten conditional for msg

* Shorten conditional for since

* Shorten conditional for until

* Specify decorator arguments in test

* Add tests for since and until arguments

* Add test for since and until as arguments

* Add test for msg argument for class

* Add test for replacement argument for class

* Remove unneeded docstring in deprecated class

* Add test for deprecate method, no args

* Update docstring examples, move deprecated method outside class

* Add test for method in class, since and message args

* Add test for deprecating nested class

* Add test for deprecated method in nested class

* Test deprecation of nested function

* Test param deprecation, only params argument

* Test deprecation of single method param

* Rename single param test method name

* Fix deprecated_params docstring whitespace

* Test parameter redirection using tuple

* Update warning msgs in deprecated_params docstring

* Test parameter redirection using lambda function

* Test param redirection from many to one

* Test param redirection from one to many

* Update Top.foo to deprecate with message

* handle empty docstrings

* fix typo

* Update poetry.lock

* Update poetry.lock

* Deprecate ShowCreation using decorator to test the docs

* Test docstring for deprecated class

* Test docstring for Bar and Baz classes

* Test docstrings for the rest of the classes

* Test docstrings for Top methods

* Test docstrings for Top.Nested

* Test docstring for nested method

* Move deprecations to deprecation system

* Some more deprecations

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

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

* fix version numbering inconsistancies

* Fix naming issue and MetaClass handling

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

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

* restart CI

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Ricky Chon <rickychon99@gmail.com>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-11 08:31:55 +02:00
Anton Ballmaier
df7a2f5dfc
Build the docs - Logging (#1461)
* test

* revert test changes

* first logging changes

* fix unrelated typo

* change to logging

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

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

* Save logs to csv file for later reading it

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

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

* fix makefile issues

* remove unnecessary comments

* clean up manim_directive

* fix local var bug

* Show log only if examples have been rendered

* Move controll from makefile to sphinx events

* remove added blank line

* remove rendering_summary file

* fix slight regex problem

* comment out code in question

* change encoding

* re-add code

* switch to build-finished event

* fix indentation bug

* use csv module

* Update manim/mobject/mobject.py

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

* Update manim/mobject/mobject.py

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

* Use Pathlib

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-09 10:56:10 +05:30
Nikhil Garuda
1746073b8c
Added entry for typestring parser check tool (#1402)
* Added typestring parser checker

* Updated some errors

* Update

* Checking if installation wokrs

* Trying again

* Updates

* Another Update

* Update pyproject.toml

* Update documentation.rst

* Update requirements.txt

* Update

* syntax highlighting should work?

* Update

* Reverted back

* Will this work?

* Update

* Still trying

* Update

* Update again

* Fixed the indentation issues

* Update

* updated code block

* Update again

* Update

* Update again with blackendocs

* Update documentation.rst

* Added skip option to doctests

* Added the link

* Update link
2021-05-06 22:26:10 -07:00
Anton Ballmaier
2d2604bca9
Add inheritance diagrams to reference page (#1441)
* test

* revert test changes

* add inheritance map

* Configure Graph to fit dark theme

* Add inheritance graphs to each section in reference

* Responsive color scheme

* remove unnecessary comment

* remove more stuff from testing

* and more still

* Update docs/source/_static/responsiveSvg.js

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

* Add graphviz explanation to docs

* add background color fix for chrome

* Add subheadings

* Chnaged Headings to singular and bold

Apply suggestions from code review

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

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-06 12:31:02 +02:00
Skaft
bbe113e7d3
Fixing broken doc links (#1457)
* fix broken links

* fix typo
2021-05-03 21:13:51 +05:30
Naveen M K
a2850c7e9a
Fix manim_directive (#1453)
Use posix path on Windows to link images
or else it doesn't work. Also, use pathlib
wherever possible
2021-05-03 02:15:33 -07:00
Skaft
199424d713
Remove $ from tutorial commands (#1445) 2021-05-03 10:47:23 +05:30
Benjamin Hackl
e5a63077cb
Prepare v0.6.0 (#1434)
* version bump

* add generated changelog

* changelog script: fix type of additional PRs

* update autogenerated changelog

* add releases category

* a bit more copyediting

* rewrite author logic

* regenerate changelog

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

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

* regenerate changelog

* merge logic for authors/reviewers and label sorting (fewer GH requests!)

* regenerate changelog

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

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

* fix some formatting and add more references

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: Jason Villanueva <a@jsonvillanueva.com>
2021-05-02 17:47:01 +02:00
Jason Villanueva
7248cf584a
Fix CLI bugs (#1431)
* First draft at fixing CLI bugs

Fixed output_file option

Removed -h help flag from manim/manim render

* Updated play logic test to use format = png

* Added suggestions, fixed test cases

* Revert file

* Fix?

* Append format to end of config_code

* Update manim/cli/render/render_options.py

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

* Add format to default.cfg

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-05-02 16:06:29 +05:30
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
Nikhil Garuda
fccce24a9b
Added Guide to Contribute Examples from GitHub Wiki to Documentation (#1387)
* Changed prepare_animation example

* Update animation.py

* Changed prepare_animation example

* Update animation.py

* Update animation.py

* Reverted

* Add Guide to Contribute Examples

* Update

* Rewrote some of the guide

Updated issues with docs rendering improperly.
Fixed some grammar.
Perhaps broke some things

* Update docs/source/contributing/documentation.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Update documentation.rst

* Update

* Update docs/source/contributing/documentation.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Trigger Build

* Updated

* Build pls work

* Update

* Update docs/source/contributing/documentation.rst

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

* Update docs/source/contributing/documentation.rst

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

* Update docs/source/contributing/documentation.rst

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

* Apply suggestions from code review

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

* updated note tab

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-30 21:59:56 +02:00
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
Darylgolden
a43d7d3e75
Added :class:Polyhedron, and platonic solids :class:Tetrahedron, :class:Octahedron, :class:Icosahedron and :class:Dodecahedron (#1348)
* Rudimentary polyhedra class

* Move to own file + more polyhedra

* Icosahedron

* More polyhedra and renaming to singular form

* Changes

* Revert changes to graph

* Fix put_start_and_end_on and attempt to add updaters

* Update polyhedra.py

* Try to fix updaters

* Fix attempts

* more attempts

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

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

* More attempts

* I got it to work

* side_length -> edge_length, start doc string

* More docs

* edge_length type hint and **kwargs

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

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

* Docs title

* Config, docs

* Submobject docs

* Basic examples for the platonic solids

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

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

* Tests, black, rm personal test file

* Make pytest work properly

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

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

* Try to fix formatting

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

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

* Adding information about polyhedra

* Rm unused imports

* Actually finish the comment

* Apply suggestions from code review

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

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

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

* Type hints for edge_length

* change faces_list type hint

* More typehints

* More typehints

* get_edges return type

* Type hint

* Replace Union[float, int] with float

* Fix typehints and attempt to fix tests

* Import dict from typehints

* Try to fix tests

* Fix typehint for mobject

* Conditional import and vgroup type hint

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

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

* Import type_checking

* Retrigger

* Update manim/mobject/polyhedra.py

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

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: kilacoda <65204531+kilacoda@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-04-29 10:51:18 +05:30
kolibril13
cf8ae0811e
Add admonitions tutorial to docs (#1389)
* more docs

* more docs

* refining

* comma fix

* refine further

* typo

* typo

* refine

* Update docs/source/contributing/documentation.rst

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

* Update docs/source/contributing/documentation.rst

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

* applied suggestions

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-28 21:03:11 -07:00
kolibril13
0b1bcb4629
Reduce complexity of ThreeDSurfacePlot example (#1341)
* tweaked 3d

* Update examples.rst

* Update examples.rst

* Update examples.rst

* Update docs/source/examples.rst
2021-04-27 20:42:25 +02:00
kolibril13
f95f183c68
Quick reference to modules (#1362)
* added quick reference to docs

* example

* added example for valtracker

* expl

* Update manim/mobject/value_tracker.py

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

* Update index.rst

* refining

* refine

* refine

* Update manim/mobject/geometry.py

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-25 08:11:20 +02:00
Nikhil Garuda
80a1bfcd2f
Add flake8 and isort in docs (#1376)
* 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

* Updated Code Style to include isort and flake8

* Update

* Update

* Delete test.py

* Update development.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update docs/source/contributing/development.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Update development.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: kilacoda <65204531+kilacoda@users.noreply.github.com>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-04-21 17:50:51 -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
Nikhil Garuda
f8beaa4ba2
Changed the format (#1358) 2021-04-18 10:20:47 +02:00
kolibril13
642b7683b2
Added documentation guidelines for type hints (#1338)
* added guidlines for typehints

* added lines

* Apply suggestions from code review

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

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* added ``None`` typehint

* added Optional

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* blacken-docs

* Update docs/source/contributing/documentation.rst

* Update documentation.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-16 21:01:21 -07:00
kolibril13
57a76db678
Mutliple VauleTracker example for docs (#1342)
* example

* typo

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-16 14:33:20 -07:00
kolibril13
5abe8a9469
Added tutorial chapter on coordinates of an mobject (#1210)
* added tutorial chapter on mobject

* Update docs/source/tutorials/building_blocks.rst

* added transform example and updated position example

* extra line

* Apply suggestions from code review

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

* Update docs/source/tutorials/building_blocks.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-15 20:40:28 +02:00
Darylgolden
d39d11b566
Added import statements to examples in documentation (#1335)
* Attempt to add import statement

* Update manim_directive.py

* Fix attempt

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-04-15 10:16:27 -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
Darylgolden
65fa84ce06
Fix typo on the Quickstart page in documentation(#1313) 2021-04-11 15:15:51 +05:30
friedkeenan
49b50cfe78
Change docs to use viewcode instead of linkcode (#1297)
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-04-09 12:54:01 -07:00
Benjamin Hackl
4fc00f7318
Switch documentation from guzzle-sphinx-theme to furo (#1251)
* prototype: switch from guzzle-sphinx-theme to furo

* try workaround for displaying navbar elements

* more specific css targeting

* further color adjustments

* manim-example block: larger font size

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

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

* remove unused import

* increase font size for references

* fix hover colors

* html_title with explicit version

* [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>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-08 20:18:02 -07:00
sparshg
08e06e156c
Render image automatically if no animation is played in a scene (#1261)
* Display image instead if attempting to make movie file with no animations

* update

* logging warnings added

* small fixes

* Fix broken test, add suggestions

* ignore skipping if scene finished

* fixes + replace self.play(Anim.. with self.add()

* dummy commit

* explicitly set write_to_movie in manim_directive

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-08 11:33:08 +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
Aron
053e40060d
Remove Carriage Return (#1281)
Co-authored-by: Aron Fischer <cobordism@github, co-bordism@gitlab>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
2021-04-07 15:22:50 -07:00
Jason Villanueva
5b2d5c3f8b
Added sphinx requirements to pyproject.toml (#1279)
* Added Sphinx dependencies to pyproject.toml

* Updated documentation

* Updates poetry.lock

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-07 21:58:38 +02: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
Jason Villanueva
1e049d8bd2
Fixed flake8 errors and removed linter/formatter workflows (#1278)
* Fixed flake8 in files outside of manim/manim

* Removed linter/formatter workflows

* Small update to pre-commit in contributing guideline

* Better English/grammar in doc
2021-04-07 06:14:14 -07: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
Naveen M K
dcb90a8656
Format Imports using Isort (#1178)
* Format imports using Isort.
Add a check for pull requests.

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

* CI: update check's name
2021-04-03 13:45:12 +05:30
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
Benjamin Hackl
47e65fe8d8
Improve changelog generation script (#1231)
* remove upcoming release heading from changelog.rst

* added -t flag to dev_changelog.py

* let generated changelog include the date

* allow passing additional (non-autodetected PRs) to the changelog

* added header and date to v0.5.0 changelog

* fix quotes in f-string

* Fixed version number from incorrect click merge

* further improvements to the script

* update 0.5.0-changelog to latest script output

* black

* Convert to click

* Update usage, added example, fixed 'additional' logic

* run script again, reduces/removes warnings from rendering documentation

* again, fix some more formatting issues

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-02 18:27:57 +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
Devin Neal
f51133be42
Merge pull request #1229 from eulertour/v0.5.0-changelog
Generate v0.5.0 changelog
2021-04-01 22:43:36 -07:00