Commit graph

27 commits

Author SHA1 Message Date
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