mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
89bcec8f2f* move plugins * plugins in main sidebar * restructure installation guide * fix some removed references * more sphinx fixes * restructured developer installation, more cleanup * rename some files * rewrote MacOS installation instructions * rewrote the windows installation guide * cleaned up linux installation instructions * added a lot of colons Co-authored-by: Jason Villanueva <a@jsonvillanueva.com> * improve first paragraph of installation.rst * move docker and jupyter to separate files * Copyediting Co-authored-by: Darylgolden <darylgolden@gmail.com> * change wording regarding colab env * copyediting, second pass Co-authored-by: Darylgolden <darylgolden@gmail.com> * first mention recommended ffmpeg installation for windows * move admonition above table of contents Co-authored-by: Jason Villanueva <a@jsonvillanueva.com> Co-authored-by: Darylgolden <darylgolden@gmail.com>
67 lines
2.1 KiB
ReStructuredText
67 lines
2.1 KiB
ReStructuredText
.. manim documentation master file, created by
|
|
sphinx-quickstart on Tue Aug 4 13:58:07 2020.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Manim Community Overview
|
|
========================
|
|
|
|
Animating technical concepts is traditionally pretty tedious since it can be
|
|
difficult to make the animations precise enough to convey them accurately.
|
|
``Manim`` uses Python to generate animations programmatically, making it
|
|
possible to specify exactly how each one should run.
|
|
|
|
This project is still very much a work in progress, but we hope that the
|
|
information here will make it easier for newcomers to get started using
|
|
``Manim``.
|
|
|
|
.. tip::
|
|
|
|
All content of the docs is licensed under the MIT license. Especially for the examples
|
|
you encounter: Feel free to use this code in your own projects!
|
|
|
|
We are curious to see the awesome projects you build using this library, feel
|
|
free to share your projects with us `on Twitter <https://twitter.com/manim_community>`_,
|
|
`Reddit <https://www.reddit.com/r/manim/>`_, or via `Discord <https://www.manim.community/discord/>`_.
|
|
|
|
In case you publish your work made with Manim, we would appreciate if you
|
|
add a link to `our homepage <https://www.manim.community>`_ or
|
|
`our GitHub repository <https://github.com/ManimCommunity/manim>`_. If you
|
|
use Manim in a scientific context, instructions on how to cite a particular
|
|
release can be found
|
|
`in our README <https://github.com/ManimCommunity/manim/blob/main/README.md>`_.
|
|
|
|
.. note::
|
|
|
|
As a quick reference, here are some often used modules, classes and methods:
|
|
|
|
Modules:
|
|
:mod:`~.moving_camera_scene`,
|
|
:mod:`~.tex_mobject`,
|
|
:mod:`~.geometry`,
|
|
|
|
Classes:
|
|
:class:`~.Mobject` ,
|
|
:class:`~.VMobject`,
|
|
:class:`~.ValueTracker`,
|
|
:class:`~.MathTex`,
|
|
:class:`~.Angle`,
|
|
:class:`~.Tex`,
|
|
:class:`~.Text`,
|
|
|
|
Methods:
|
|
:meth:`~.Mobject.add_updater`,
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
installation
|
|
tutorials
|
|
examples
|
|
changelog
|
|
reference
|
|
plugins
|
|
reporting_bugs
|
|
contributing
|
|
conduct
|