sphinx_rtd_theme icon indicating copy to clipboard operation
sphinx_rtd_theme copied to clipboard

Published 20 hours ago • verified publisher icon readthedocs

Update to font awesome 5

Open Blendify opened this issue 3 years ago • 5 comments

This is still a work in progress

  • [x] fix font file not being found

Blendify avatar Feb 27 '21 04:02 Blendify

I was having a hard time getting this to work without having to set the font face for .fas it doesn't seem like this should be necessary, it wasn't before and I don't see anything in the FA docs about this so maybe I am doing something wrong.

Blendify avatar Mar 01 '21 15:03 Blendify

Fork Awesome activity seems have stalled since October, but something to consider: https://forkaweso.me/Fork-Awesome/whats-new/ https://github.com/FortAwesome/Font-Awesome/issues/12199#issuecomment-362919956

@agjohnson I don't know how feasible using fa- with FA 5 is, but Fork Awesome still uses fa-.

polyzen avatar Mar 12 '21 21:03 polyzen

Yeah I don't think trying to keep the use of fa- is a good idea, It makes it confusing for developers to know if we are using fa5 when we make a hack to continue using fa4 syntax.

I also don't think using a fork of fa is a good idea either, this will only add headaches when the fork is no longer maintained which seems to already be the case.

Blendify avatar Mar 15 '21 19:03 Blendify

There are font awesome 4 shims available for font awesome solid. This would be the best intermediate step without cutting a backwards incompatible release.

If we keep the font awesome solid prefix, this is a strong breaking change for downstream users and we're likely already then talking about a v2.0 release with this change. v1.0 is shaping up to be dropping Sphinx <1.6 support.

agjohnson avatar Mar 17 '21 19:03 agjohnson

I still feel that this is an easy backwards incompatible change to avoid and that we should add the FA4 class naming to provide some small amount of insurance here. The end user can always customize on top of our theme, and could be expecting these classes that the theme has been providing. It will be difficult to catch this or warn the user about this, so I lean towards avoiding this scenario, especially with the number of points of backwards incompatibility that we already have.

This only requires defining the additional class name to set the font-family and font-weight. Here's an example of defining the classes manually:

https://github.com/readthedocs/sui-common-theme/blob/236e6b12ae93d99321cf930fbb567d7964d5ea36/elements/icon.overrides#L7-L26

I'll include this in a later milestone for now.

agjohnson avatar Sep 28 '23 16:09 agjohnson