Sphinx Readthedocs theme Font-awesome integration

Я знаю, что это может быть очень глупый вопрос, но мне не удалось найти что-нибудь онлайн о потенциальном решении.Sphinx Readthedocs theme Font-awesome integration

Я использую Sphinx 1.4 и sphinx_rtd_theme, чтобы создать документацию для моего проекта Django. Я пытаюсь найти способ использовать шрифт-удивительные значки в файлах .rst, но не нашел способа сделать это. Я посмотрел исходные файлы sphinx_rtd_theme, а значки fa- * включены в файл theme.css. Тем не менее, я не знаю, как их включить.

Является ли это директивой, интерпретированным текстом или чем-то подобным? Я пробовал icon, fonticon и fa как ни один из вышеперечисленных и не работал.

Любая помощь будет оценена по достоинству.

Я знаю, что могу использовать необработанный HTML, но я бы хотел избежать этого, если это вообще возможно.

источник

2016-06-23 Vlad B

Вы пробовали смотреть на, например, https://anil.io/cheatsheets/sphinx/bootstrap-restructured-text-sphinx-directives.html#font-awesome-icons? По состоянию на январь, [по-видимому] (http://blog.gmane.org/gmane.comp.python.sphinx.devel/month=20160101), 'raw :: html' был способом пойти, если у вас нет любые дополнительные плагины. – jonrsharpe

Привет, я попробовал: fa: ранее (попробовал это снова сейчас, скопировал и вставил его из ссылки, которую вы мне отправили), но я получаю ту же ошибку, что и раньше: 'docs/source/manual/menus/mainmenu. rst: 55: ОШИБКА: Неизвестная интерпретированная текстовая роль «fa». EDIT: Мои извинения. Я только теперь понял, что это внешняя библиотека. У меня будет другой взгляд. –

Тогда я предполагаю, что это только если вы используете Bootstrap RST. – jonrsharpe

Вы можете использовать директиву 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-23 18:07:52

Это прекрасно работает, именно то, что я искал. Я также хочу создать .pdf из тех же .rst-файлов, и они не отображают значки, но я, вероятно, могу обойти это. Отлично работает для файлов .html! –

ответ

Смежные вопросы