1

我知道这可能是一个非常愚蠢的问题，但我没有设法在网上找到任何关于潜在解决方案的信息。

我正在使用Sphinx 1.4和sphinx_rtd_theme为我的 Django 项目生成一些文档。我一直在尝试找到一种在 .rst 文件中使用字体真棒图标的方法，但没有找到方法。我查看了 sphinx_rtd_theme 源文件，并且 fa-* 图标包含在 theme.css 文件中。但是，我不知道实际上包含它们的方法。

它是指令、解释文本还是类似的东西？我已经尝试过icon、fonticon和fa作为上述任何一种方法，但都没有奏效。

任何帮助，将不胜感激。

我知道我可能会使用原始 HTML，但如果可能的话，我想避免这种情况。

4

4 回答 4

2

您可以使用 Sphinx 的rst-class指令，如下所示：

.. rst-class:: fa fa-fontawesome

   the font awsome flag will be attached to this paragraph

rst-class将为指定的下一个元素设置类属性。

以下代码仅呈现图标：

.. rst-class:: fa fa-font-awesome

   |

当然，您也可以使用自定义类来进一步设置元素的样式。

于 2016-06-23T18:07:52.713 回答
1

您还可以使用https://sphinx-panels.readthedocs.io/en/latest/#inline-icons：

:fa:`bars`
:fa:`spinner,text-white bg-primary fa-2x,style=fa`
于 2020-05-19T04:58:46.453 回答
0

我刚刚学习 Sphinx 并且有同样的问题，但使用原始 HTML 对我来说很好。也许这个解决方案会对那里的人有所帮助......

在conf.py文件中，添加指向您的 Fontawesome 套件代码 URL 的链接

html_js_files = [
    'https://kit.fontawesome.com/##########.js',
]

然后，在 Sphinx 中使用带有原始 HTML 指令的 fontawesome 图标

.. |fa-fort-awesome| raw:: html

   <i class="fab fa-fort-awesome"></i>

Here is some text |fa-fort-awesome| with the icon in the middle.

这是它呈现为 HTML 的方式...

在此处输入图像描述

于 2020-05-05T21:54:48.870 回答
-1

为了使图标在 HTML 和 Latex 上可用，请从 https://fontawesome.com/download下载 FontAwesome Web 包，将 font-awesome/svgs/solid 包含到您的项目 _static 文件夹中，并使用如下图像指令：

The |fa-bars| function is to toggle the left Sidebar Menu between being collapsed behind the button or displayed on the screen.

.. |fa-bars| image:: _static/font-awesome/svgs/solid/bars.svg
:width: 20px
:alt: hamburguer button

结果：

<link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"/>
The <i class="fa fa-bars"></i> function is to toggle the left Sidebar Menu between being collapsed behind the button or displayed on the screen.

于 2019-08-20T21:01:27.963 回答