FontAwesome !works

[dylanh724]

Describe the bug

context
When I do ___:

FA Test
-------

- An icon :fas:`spinner;sd-text-primary`, some more text.
- An icon :fab:`github`, some more text.
- An icon :fab:`gitkraken;sd-text-success fa-xl`, some more text.
- An icon :fas:`skull;sd-text-danger`, some more text.

expectation
I expected FA icons to appear as shown in the parent PyData doc

bug
But instead no FA icon appears; instead, they appear as an #anchored link that literally shows:

:fab:`github`

problem
This is a problem for anyone trying to use FontAwesome.

Reproduce the bug

FA Test

• An icon :fas:spinner;sd-text-primary, some more text.
• An icon :fab:github, some more text.
• An icon :fab:gitkraken;sd-text-success fa-xl, some more text.
• An icon :fas:skull;sd-text-danger, some more text.

List your environment

• python 3.10
• win11
• sphinx-book-theme 1.1.3
• sphinx 7.3.7

[agoose77]

The font-awesome icon roles are defined in sphinx-design, not sphinx-book-theme. Have you installed and enabled it?

[dylanh724]

The font-awesome icon roles are defined in sphinx-design, not sphinx-book-theme. Have you installed and enabled it?

I have not :) I had no clue it was separate. Is there a doc you can point me to that instructs this? I'm curious how one normally finds this.

[dylanh724]

(Heads up, the quickstart instructions for sphinx-design is wrong):

https://sphinx-design.readthedocs.io/en/latest/get_started.html

It's pip sphinx_design, not sphinx-design (that seems to exist, but dated)

[dylanh724]

Many thanks, friend. However, I am going to leave this ticket open since this may still be a task. I went back to onboarding looked around similar sections regarding styling, but still couldn't find a direction to what you just told me.