一个简单的sphinx扩展,可以从G'MIC命令生成图像

gmic-sphinx的Python项目详细描述


gmic狮身人面像

PyPI version

使用gmic-pyPython绑定将G'MIC命令结果显示为图像的Sphinx扩展。在

使用

这个Sphinx扩展添加了一个新的指令名gmicpic,它以任何gmic表达式作为输入,并输出一个图像和下面的gmic命令作为标题(其他可能会在后面出现)。目前只使用Sphinx的html生成器对其进行了测试。在

它只适用于reStructuredText (aka ReST) documentation format,而不是Markdown或其他。在

.rst文件中,添加以下内容:

..gmicpic:: your gmic command

例如:

^{pr2}$

将生成一个名为earthy.png的图片文件,后跟命令作为标题:

Image of gmic-library-blurred earth

sp地球模糊4输出土.png在

G'MIC命令预处理

  1. output参数是可选的。在
  2. 为了防止在文档构建时出现代理阻塞问题,G'MIC的示例存储在以下扩展中:
..gmicpic:: sp leno blur 4

将生成一个名为cce2fce2-e6fc-11ea-9e0e-8cec4b8c0881.png的图片文件,后面是命令作为标题:

Image of gmic-library-blurred leno

丝网模糊4

…意味着纱罗.png存在于gmic_samples目录中(我们已经为您完成了<;=2020图像示例)。 生成的隐式output图像将预存储在gmic images/中,并使用生成的唯一id .png文件名。在

安装和设置

从以下位置安装此Python模块pypi.org网站与斯芬克斯在虚拟环境中相同):

pip install gmic-sphinx

编辑Sphinx文档项目的conf.py文件,并确保您的行如下:

extensions=['gmic-sphinx']

您可能需要将gmicsphinx添加到Python路径中。在

使用此的项目

此扩展用于以下项目:

测试

自动pytest测试用例在Github Actions选项卡中运行。您也可以在Python>;=3.7环境中运行它们。在

安装测试要求:

pip install dev-requirements.txt

在本地安装程序包:

pip install .

运行pytest测试套件:

py.test tests/

释放

如果您是维护者,并且希望触发此项目的新版本,则不需要任何凭据,因为它们存储为该项目的Github Secret。 你只需要:

  1. 更改gmic_sphinx/gmicpic.pysetup()函数和gmic_sphinx/gmicpic.py函数中的版本号。在
  2. 如本文Github Action Worfklow file所述,Git推送一个新标记。在

许可证

这个项目在CeCILL License下。在

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java FirebaseInstanceId。getInstance()始终为空   linux Java执行文件错误   javaspringboot:如何使用Ajax在springboot和Thymeleaf中创建进度条?   java禁用在安卓上使用传单时启用setJavaScriptEnabled   java如何在主体中发布原始类型JSON数据?   消除JAVA While循环中的额外输出   如何在java中直接将基本数据类型分配给自定义类   java为什么addNode()方法返回编译错误“类型中的方法…不适用于参数…”,我该如何修复它?   java惰性合成可观察对象   eclipse Java Blackberry位图单击   java Android:AsyncTask对象[]无法在doInBackground中强制转换   java有没有办法重构或改进这段代码?   java如何使用系统以十六进制打印字节。出来普林顿?   多线程如何在我的java聊天室中调试“java.net.UnknownHostException”?   java如何从Google App Engine下载应用程序源文件   java如何在Spring Data Mongo的聚合$group中使用类似$dateToString   java IBM websphere application server未在MyEclipse8中启动。0