跳转到主要内容

sphinx-btn是一个Sphinx自定义角色,用于在LaTeX和HTML输出中嵌入内联按钮,该按钮是一个图标。

项目描述

License: BSD 2-Clause PyPI supported Python version GitHub Workflow Status Codecov Read the Docs Black badge conventional commit

概述

sphinx-btn是一个Sphinx扩展,允许开发者在他们的文档中使用btn角色来显示内联按钮。按钮由一个图标和/或一些文本组成。该扩展目前仅支持Fontawsome 6.3.0图标。

I'm a :btn:`<fa-solid fa-folder> fa-folder` btn.
I'm a :btn:`<fa-solid fa-folder>` btn.
I'm a :btn:`fa-folder` btn.
demo result

如果您想了解更多信息,请访问我们的文档

贡献

如果您想贡献,您可以在您自己的仓库中fork该项目并使用它。如果您考虑与我们合作,请遵循贡献指南。了解我们的贡献者

项目细节


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分发

sphinx-btn-0.1.2.tar.gz (5.9 kB 查看哈希值)

上传时间 源代码

构建分发

sphinx_btn-0.1.2-py3-none-any.whl (5.2 kB 查看哈希值)

上传时间 Python 3

由以下支持