sphinx-design icon indicating copy to clipboard operation
sphinx-design copied to clipboard

use fa6 icon names

Open 12rambau opened this issue 2 years ago • 2 comments

You are using the role name to define the style of the icon, it should be aligned with the version of font awesome advertised i.e. fa6.

To avoid older documentations with hundreds of icons stopping working overnight I added a correspondence table between the fa keys as they are changing between each version. o you think it would be useful to raise a warning when using an old one?

the "fas" style is deprecated since fontawesome 6. it has been changed to fa-solid in the html output. Check your icon as names are also changing between version

note: there is a bug in the pre-commit checks that is not related to my modifications.

12rambau avatar Feb 04 '23 08:02 12rambau

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

welcome[bot] avatar Feb 04 '23 08:02 welcome[bot]

Codecov Report

Base: 90.02% // Head: 90.02% // No change to project coverage :thumbsup:

Coverage data is based on head (b0d773a) compared to base (6df4751). Patch coverage: 100.00% of modified lines in pull request are covered.

:exclamation: Current head b0d773a differs from pull request most recent head 917506a. Consider uploading reports for the commit 917506a to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #121   +/-   ##
=======================================
  Coverage   90.02%   90.02%           
=======================================
  Files          11       11           
  Lines         942      942           
=======================================
  Hits          848      848           
  Misses         94       94           
Flag Coverage Δ
pytests 90.02% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
sphinx_design/icons.py 79.64% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov-commenter avatar Feb 04 '23 09:02 codecov-commenter

Heya, thanks but... Since both short and long names are supported in v6 (see https://docs.fontawesome.com/web/add-icons/how-to#aliases and https://docs.fontawesome.com/web/setup/upgrade/whats-changed#full-style-names), but long names are not supported in v5, and the fact that I prefer the shorter names for roles (to keep things terse), I am closing this PR for now

chrisjsewell avatar May 20 '24 23:05 chrisjsewell