Commit graph

37 commits

Author SHA1 Message Date
Benjamin Hackl
4368b972af
Fixed broken links in inheritance graphs by moving them to `reference.rst` (#2122)
* moved inheritance graphs to reference.rst to resolve wrong link targets

* [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-10-01 14:08:22 +02:00
Benjamin Hackl
17a3c637e8
Improve sidebar structure of reference manual (#1778)
* move modules in reference manual around to have nicer sidebar structure

* use short names in page titles and sidebar

* fix broken reference

* remove some autogenerated files that shouldn't be tracked

* include module list in reference.html

Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-07-19 12:19:21 -04:00
Laith Bahodi
0cb5778693
Added :class:~.Broadcast animation. (#1719)
* add broadcast, with docs and generalized to any mobjects

* use opacity, not colour

* update docs to reflect opacity switch

* add example and add attrs

* switch some params around

* copyediting

* Apply suggestions from code review - lag_raito --> lag_ratio

Co-authored-by: Raghav Goel <kilacoda@gmail.com>

* add to docs

* Apply suggestions from code review

Co-authored-by: Abhijith Muthyala <73361366+abhi3019@users.noreply.github.com>

* fix typo in docs and use stroke opacity not overall opacity

* adjust docs and make remover work

* docs acting weird, drop quotes?

* add check for fill_opacity

* attempt at fixing the docs

* remove type hints in __new__ to make them work elsewhere?

* add comment

Co-authored-by: Raghav Goel <kilacoda@gmail.com>
Co-authored-by: Abhijith Muthyala <73361366+abhi3019@users.noreply.github.com>
2021-07-18 12:52:20 +08:00
Jason Villanueva
6f13981f23
Removed Container ABC (#1652)
* Removed Container ABC and unnecessary imports

* Remove test for container

* Remove kwargs from Scene/Mobject

* Updated NumberLine and related test

* Fix graphscene test by removing unused arg

* Fix other TypeError issues in other test cases

* Fix doctest

* Fixed usages of ParametricFunction

* Removed stale references to container

* Removed unused parameters passed to Paragraph

* Added style parameter to prevent errors from MarkupText/Text

* Remove unnecessary style parameter

* Update tests/test_number_line.py

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>

* Remove numberline parameters

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

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

* Update scene.py

* Remove unused font_size param

* Removed leftover font_size

* Apply suggestions from code review

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

* Readded tests for Mobjects/Scene without Container

* Applied suggestion for PointCloudMobject

* Pass path_string_config only if OpenGL

* Readds args to Paragraph, removes **config from VGroup.__init__ calls

* Fixed test_scene test case and removed added param

* Apply second pass suggestions

* Fix incorrect merge in Mobject

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>
Co-authored-by: friedkeenan <friedkeenan@protonmail.com>
2021-06-24 08:13:24 -07:00
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
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
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
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
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
Benjamin Hackl
b09919febe
Added new fade and transform animations (:class:~.TransformMatchingShapes, :class:~.TransformMatchingTex, :class:~.FadeTransform) from 3b1b/manim (#1037)
* bring over and patch up code for shape matching transforms from 3b1b/manim

* convert passed arguments to strings when processing Tex

* move FadeTransform from animation.fading to animation.transform

* documentation for FadeOutToPoint

* black

* documentation + minor cleanups for animation.transform_matching_parts

* include transform_matching_parts in reference manual

* flake

* remove an overlooked group_type kwarg

* fix docstring formatting

* added missing typings
2021-03-30 12:31:54 +02:00
Mark Miller
aa873e0f8e
Add forgotten svg files to documentation and imports (#1088) 2021-03-09 15:04:24 -08: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
Benjamin Hackl
e16f9a6cc4
Basic implementation of undirected graphs (#861)
* toying around with a graph using networkx layouting

* basic implementation and documentation of a class for undirected graphs

* import graph module into global namespace

* add graph module to documentation

* poetry: add networkx as a dependency

* remove some debug prints

* sort all extracted mobjects w.r.t. z_index

* add test for z_index (from #327)

* more complex z_index test

* black

* improve imports

* use z_index to have edges below vertices

* add type hints

* rename some tests to make space for graph tests

* fix problem with manual positioning

* add test

* black

* new animate syntax

* document label_fill_color
2020-12-31 21:10:41 +01:00
Benjamin Hackl
b46d21e00e
Utility class for animated Manim banner (#729)
* first suggestion for working expansion

* minimal docs

* Update manim/utils/manim_banner.py

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

* added import statement

* newline between manim directive and first code line

* get rid of silly local variables

* make it easier to understand shift

* forgot to replace occurrence of ds_m

* this is what I would really like to work

* black

* change output of gnufsfs template to .xdv

* revert to uglier but working version of ManimBanner.expand

* typo in docstring

* dark and light background examples

* expose ManimBanner

* remove updater method

* forgot to rename example classes

* change banner position in BannerLightBackground

* utils.manim_banner --> mobject.logo

* fix import

* add more documentation

* small fix for scale

* add comment for anim not being a submobject

* move comment to make black happy

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Leo Torres <dleonardotn@gmail.com>
Co-authored-by: kolibril13 <jan-hendrik.mueller@gmx.net>
2020-12-01 01:42:16 +01: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
Benjamin Hackl
c6cc603c4b remove drawing and animation.specialized from reference manual as well 2020-11-07 02:02:30 +01:00
leotrs
276e0f1329 Merge branch 'master' into feat-manim-configdict 2020-10-27 21:27:05 -04:00
Benjamin Hackl
1d863e469d
Improve design of documentation (#617)
* redesign documentation \o/

* outline 0 for videos

* forgot border-color for source blocks

* adapt styling for example references

* change link and text color

* suggestion for new order of top-level docs

* mathematical objects --> mobjects
2020-10-27 19:54:03 +01:00
leotrs
b15f5fdd2c fix docs 2020-10-26 18:30:21 -04:00
leotrs
12e1e528eb merge master 2020-10-26 17:46:00 -04:00
Benjamin Hackl
1e2310f8c9 remove three_d_shading_utils 2020-10-23 11:51:01 +02:00
Benjamin Hackl
079c337d83
Move changelog to main TOC (#597) 2020-10-22 20:00:06 +05:30
Aron Fischer
f9859d0eb0 Better docstrings. Move all but three templates to TexTemplateLibrary 2020-10-09 18:45:15 +02:00
Benjamin Hackl
5467978110
Improve/extend reference manual (#438)
* include _all_ modules in reference manual

* improve table of contents in sidebar

* modify class template: no longer use separate files for all methods

* no signatures in table overview

* rewrite code_mobject module docstring

* add one-line module docstrings

* rudimentary documentation of changing.py

* add example to ValueTracker

* clarify that Text does not use LaTeX

Co-authored-by: Leo Torres <dleonardotn@gmail.com>
Co-authored-by: Hugues Devimeux <36239975+huguesdevimeux@users.noreply.github.com>
2020-09-16 11:08:07 -04:00
leotrs
2c94a5c792 Make it so that the config module is reachable, as _config. This is used e.g. in the docs. This also fixes an image path in docs/source/contributing.md. 2020-08-24 08:27:32 -04:00
leotrs
cf66a22a4c add some other modules to the API reference 2020-08-21 22:34:26 -04:00
leotrs
5c657ff4da some changes to prettify the docs output 2020-08-21 22:01:25 -04:00
Leo Torres
271c235f78
Documentation: finish quickstart and add installation instructions (#324)
* 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

* update contributing guidelines

* convert quickstart doc from md to rst. Also add a troubleshooting stub file

* finish the second part of the quickstart

* add general and linux instructions

* add mac instructions

* add windows install instructions

* final touches

* Update docs/source/installation/win.rst

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

* Update a_deeper_look.rst

added explanation on the  ``-s`` flag

* Update docs/source/installation/installation_linux.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* updates from code review

* update from code review

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
2020-08-21 20:40:27 -04:00
Leo Torres
aada9f00f0
Change the folder of auto-generated reference from _autosummary to reference. This will change the URLs as well so they look prettier. I also moved the installation/examples/tutorials indices one folder up so the URLs look less messy and more straightforward as well. (#312) 2020-08-17 07:43:52 -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
Leo Torres
dc5abe3917
Merge pull request #297 from ManimCommunity/organize_sphinx_chapters
# Docs-Chapters rearranged
2020-08-15 22:04:46 -04:00
kolibril13
68046dfbe0 # fixed typos 2020-08-15 19:59:54 +02:00
leotrs
db354ff9b9 update docs 2020-08-15 13:18:48 -04:00
kolibril13
2752a47279 added changelog an gifs 2020-08-15 15:31:56 +02:00
kolibril13
ba418692f9 # Restructured the docs-chapters 2020-08-15 12:57:38 +02:00
leotrs
b83193a702 use the autosummary extension to automatically generate module and class files 2020-08-14 11:04:58 -04:00
leotrs
94f004d5f6 initial sphinx setup 2020-08-04 14:51:16 -04:00