mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
1e496579f6* bump version number * changelog generation, first pass * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * changelog generation, second pass * changelog generation, third pass * update i18n * removed reference to deleted module * changelog generation, fourth pass Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
109 lines
4.6 KiB
Text
109 lines
4.6 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/contributing/examples.rst:3
|
|
msgid "Adding Examples"
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:5
|
|
msgid "This is a page for adding examples to the documentation. Here are some guidelines you should follow before you publish your examples."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:9
|
|
msgid "Guidelines for examples"
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:11
|
|
msgid "Everybody is welcome to contribute examples to the documentation. Since straightforward examples are a great resource for quickly learning manim, here are some guidelines."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:15
|
|
msgid "What makes a great example"
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:19
|
|
msgid "As soon as a new version of manim is released, the documentation will be a snapshot of that version. Examples contributed after the release will only be shown in the latest documentation."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:22
|
|
msgid "Examples should be ready to copy and paste for use."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:24
|
|
msgid "Examples should be brief yet still easy to understand."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:26
|
|
msgid "Examples don't require the ``from manim import *`` statement, this will be added automatically when the docs are built."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:28
|
|
msgid "There should be a balance of animated and non-animated examples."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:30
|
|
msgid "As manim makes animations, we can include lots of animated examples; however, our RTD has a maximum 20 minutes to build. Animated examples should only be used when necessary, as last frame examples render faster."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:32
|
|
msgid "Lots of examples (e.g. size of a plot-axis, setting opacities, making texts, etc.) will also work as images. It is a lot more convenient to see the end product immediately instead of waiting for an animation to reveal it."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:34
|
|
msgid "Please ensure the examples run on the current main branch when you contribute an example."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:36
|
|
msgid "If the functions used are confusing for people, make sure to add comments in the example to explain what they do."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:39
|
|
msgid "How examples are structured"
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:41
|
|
msgid "Examples can be organized into chapters and subchapters."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:43
|
|
msgid "When you create examples, the beginning example chapter should focus on only one functionality. When the functionality is simple, multiple ideas can be illustrated under a single example."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:45
|
|
msgid "As soon as simple functionalities are explained, the chapter may include more complex examples which build on the simpler ideas."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:48
|
|
msgid "Writing examples"
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:50
|
|
msgid "When you want to add/edit examples, they can be found in the ``docs/source/`` directory, or directly in the manim source code (e.g. ``manim/mobject/mobject.py``). The examples are written in ``rst`` format and use the manim directive (see :mod:`manim.utils.docbuild.manim_directive` ), ``.. manim::``. Every example is in its own block, and looks like this:"
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:67
|
|
msgid "In the building process of the docs, all ``rst`` files are scanned, and the manim directive (``.. manim::``) blocks are identified as scenes that will be run by the current version of manim. Here is the syntax:"
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:72
|
|
msgid "``.. manim:: [SCENE_NAME]`` has no indentation and ``SCENE_NAME`` refers to the name of the class below."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:74
|
|
msgid "The flags are followed in the next line (no blank line here!), with the indentation level of one tab."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:76
|
|
msgid "All possible flags can be found at :mod:`manim.utils.docbuild.manim_directive`."
|
|
msgstr ""
|
|
|
|
#: ../../source/contributing/examples.rst:78
|
|
msgid "In the example above, the ``Formula1`` following ``.. manim::`` is the scene that the directive expects to render; thus, in the python code, the class has the same name: ``class Formula1(Scene)``."
|
|
msgstr ""
|
|
|
|
|