Follow-up to #3501
This commit combines all the installation documentation onto one page, and switches to recommending the usage
of `uv` for installing Manim.
* Explained ReplacementTransform vs Transform
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Added section explaining Transform vs ReplacementTransform
* Added a->b->c example
* Clarified explanation
* Fixed Typo
* Fixed missing colon
* [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: Tristan Schulz <mrdiverlp@gmail.com>
* 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>
* 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>
* Deprecated ShowCreation in favor of Create
* Fixed Black formatting and logger error
* Fixed relative import issue of logger
* Renamed CreateThen.. calls to previous names
* Fixed __all__ classes, fixed Create inheritance
* Update manim/animation/creation.py
Move logger warning to class initializer
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
* 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>
* #added some examples to the camera scene
* #added 3 ZoomedScene examples
* #removed accidentally added files
* #added updater examples
* #added text examples
* #renamed example
* #added 3d example with other light source
* #added imagemobject examples
* # added one line of code
* # small fix
* # added 3d examples
* # added one advanced project
* fixed error
* small changes
* 3d render
* another idea with the file 3d_fix.rst
* # one more change
* some more formula examples
* fix indent
* remove reference to examples/3d_fix
* change default resolution for videos in doc to 480p30
* Apply suggestions leotrs
Co-authored-by: Leo Torres <leo@leotrs.com>
* Added credits and 3d scene changes
* # removed unnecessary lines
* # implemented lots of changes suggested be leotrs
* # updated credits
* # updated scene names
* Update docs/source/examples/shapes.rst
Co-authored-by: Leo Torres <leo@leotrs.com>
* updated credits
* updated examples entery
* Update camera_settings.rst
* changed two lines
* Update shapes.rst
* Update plots.rst
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Leo Torres <leo@leotrs.com>
* add a section to the quickstart explaining the basics of building a scene
* add the internals_basic tutorial. Currently contains the section for Mobjects only
Co-authored by @behackl
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
* 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>
