manim_directive

一个用于在Sphinx文档中包含Manim视频的指令

在渲染HTML文档时，这里实现的.. manim::指令允许包含渲染的视频。

它的基本用法允许处理内联内容，如下所示：

.. manim:: MyScene

    class MyScene(Scene):
        def construct(self):
            ...

需要将表示要渲染的场景的类的名称传递给指令。

作为第二个应用，该指令也可以用于渲染在doctests中定义的场景，例如：

.. manim:: DirectiveDoctestExample
    :ref_classes: Dot

    >>> from manim import Create, Dot, RED, Scene
    >>> dot = Dot(color=RED)
    >>> dot.color
    ManimColor('#FC6255')
    >>> class DirectiveDoctestExample(Scene):
    ...     def construct(self):
    ...         self.play(Create(dot))

选项

选项可以按如下方式传递：

.. manim:: <Class name>
    :<option name>: <value>

该指令支持以下配置选项：

hide_source

如果此标志存在但没有参数，则渲染的视频上方不会显示源代码。

no_autoplay

如果此标志存在但没有参数，视频将不会自动播放。

quality{‘low’, ‘medium’, ‘high’, ‘fourk’}

控制视频的渲染质量，类似于相应的命令行标志。

save_as_gif

如果此标志存在但没有参数， 场景将渲染为gif。

save_last_frame

如果此标志存在但没有参数，将渲染并显示代表场景最后一帧的图像，而不是视频。

ref_classes

一个由空格分隔的类列表，它在源代码之后的参考块中呈现。

ref_functions

一个由空格分隔的函数列表，在源代码之后以参考块的形式呈现。

ref_methods

一个由空格分隔的方法列表，在源代码之后以参考块的形式呈现。

类

ManimDirective

manim指令，在构建文档时渲染视频。

SkipManimNode

辅助节点类，当存在skip-manim标签或正在构建.pot文件时使用。

函数

depart(self, node)[source]
Parameters:
Return type:

无

process_name_list(option_input, reference_type)[source]

将一串以空格分隔的类名重新格式化为包含有效Sphinx引用的字符串列表。

测试

>>> process_name_list("Tex TexTemplate", "class")
[':class:`~.Tex`', ':class:`~.TexTemplate`']
>>> process_name_list("Scene.play Mobject.rotate", "func")
[':func:`~.Scene.play`', ':func:`~.Mobject.rotate`']
Parameters:

  • option_input (str)

  • reference_type (str)

Return type:

列表[字符串]

setup(app)[source]
Parameters:

app (Sphinx)

Return type:

字典[字符串, 任意类型]

visit(self, node, name='')[来源]
Parameters:
Return type:

无