Sphinx-Stylo

项目
代码
PyPi

对于这个扩展来说，目前处于非常早期阶段。它可能不太稳定

Sphinx-Stylo是Sphinx文档工具的扩展，允许您使用Sphinx插入由Stylo python库动态生成的图片。图片可以使用在您的rst源文件内联定义的.. stylo-image::指令来定义。

.. stylo-image::
   :align: center
   :img-width: 1920
   :img-height: 1080
   :display-width: 75%

   from stylo.color import FillColor
   from stylo.shape import Circle
   from stylo.image import SimpleImage

   color = FillColor("ffff00)
   circle = Circle(fill=True)

   image = SimpleImage(circle, color)

然后在运行sphinx构建时，您的代码将被执行，并在最终的HTML页面中插入给定尺寸的图片。

如果您希望在插入的图片旁边包含代码，请将:include-code:选项添加到指令下的选项列表中。

您必须将图片存储在名为image的变量中，以便扩展可以捕获它。

入门

如果您想在文档中使用此扩展，则首先需要使用pip安装扩展。

$ pip install sphinx-stylo

然后您需要将扩展添加到项目conf.py中的extensions = []列表中。

extensions = [
    ...
    "sphinx_stylo"
]