使用内联代码和stylo将图像插入sphinx文档
sphinx-stylo的Python项目详细描述
狮身人面像
Project | |
Code | |
PyPi |
对于这个扩展来说,这是非常早期的阶段。它不太可能是健壮的
狮身人面像是Sphinx的延伸
文档工具,允许您插入使用
Stylopython库。可以定义图像
在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=[..."sphinx_stylo"]