Sphinx Readthedocs主题Font-awesome integration

Question

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

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

是指令，解释文本还是类似的东西？我已尝试将图标， fonticon 和 fa 作为上述任何一项，但均无效。

任何帮助将不胜感激。

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

Answer 1

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

.. rst-class:: fa fa-fontawesome

   the font awsome flag will be attached to this paragraph

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

以下代码仅呈现图标：

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

   |

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

Answer 2

我只是在学习Sphinx，并且有相同的问题，但是对于我的情况，使用原始HTML是可以的。也许此解决方案将对那里的人有帮助...

在conf.py文件中，添加一个指向Fontawesome Kit代码URL的链接

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

然后，使用原始HTML指令在Sphinx中使用惊人的图标

.. |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呈现的方式...

Answer 3

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

s2

Answer 4

为了使图标在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.