mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
e147a9fc6c* bump version number * update docs, citation, citation template * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * removed dependabot from contributor list * generated changelog, second pass * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * generated changelog, third pass * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * generated changelog, fourth pass * regenerated changelog, fifth pass * fixed minor issues in generated changelog * updated translations * added one final PR to the release Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
97 lines
3.8 KiB
Text
97 lines
3.8 KiB
Text
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: Manim \n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
|
|
#: ../../source/plugins.rst:5
|
|
msgid "Plugins"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:7
|
|
msgid "Plugins are features that extend Manim's core functionality. Since Manim is extensible and not everything belongs in its core, we'll go over how to install, use, and create your own plugins."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:13
|
|
msgid "The standard naming convention for plugins is to prefix the plugin with ``manim-``. This makes them easy for users to find on package repositories such as PyPI."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:19
|
|
msgid "The plugin feature is new and under active development. Expect updates for the best practices on installing, using, and creating plugins; as well as new subcommands/flags for ``manim plugins``"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:25
|
|
msgid "See https://plugins.manim.community/ for the list of plugins available."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:28
|
|
msgid "Installing Plugins"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:29
|
|
msgid "Plugins can be easily installed via the ``pip`` command:"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:36
|
|
msgid "After installing a plugin, you may use the ``manim plugins`` command to list your available plugins, see the following help output:"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:52
|
|
msgid "You can list plugins as such:"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:61
|
|
msgid "Using Plugins in Projects"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:62
|
|
msgid "For enabling a plugin ``manim.cfg`` or command line parameters should be used."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:66
|
|
msgid "The plugins should be module name of the plugin and not PyPi name."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:68
|
|
msgid "Enabling plugins through ``manim.cfg``"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:75
|
|
msgid "For specifying multiple plugins, comma-separated values must be used."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:83
|
|
msgid "Creating Plugins"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:84
|
|
msgid "Plugins are intended to extend Manim's core functionality. If you aren't sure whether a feature should be included in Manim's core, feel free to ask over on the `Discord server <https://www.manim.community/discord/>`_. Visit `manim-plugintemplate <https://pypi.org/project/manim-plugintemplate/>`_ on PyPI.org which serves as an in-depth tutorial for creating plugins."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:94
|
|
msgid "The only requirement of manim plugins is that they specify an entry point with the group, ``\"manim.plugins\"``. This allows Manim to discover plugins available in the user's environment. Everything regarding the plugin's directory structure, build system, and naming are completely up to your discretion as an author. The aforementioned template plugin is only a model using Poetry since this is the build system Manim uses. The plugin's `entry point <https://packaging.python.org/specifications/entry-points/>`_ can be specified in poetry as:"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:108
|
|
msgid "Here ``name`` is the name of the module of the plugin."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:110
|
|
msgid "Here ``object_reference`` can point to either a function in a module or a module itself. For example,"
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:118
|
|
msgid "Here a module is used as ``object_reference``, and when this plugin is enabled, Manim will look for ``__all__`` keyword defined in ``manim_plugintemplate`` and everything as a global variable one by one."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:122
|
|
msgid "If ``object_reference`` is a function, Manim calls the function and expects the function to return a list of modules or functions that need to be defined globally."
|
|
msgstr ""
|
|
|
|
#: ../../source/plugins.rst:125
|
|
msgid "For example,"
|
|
msgstr ""
|
|
|
|
|