✨ NEW: Add material design icons roles

[2bndy5]

resolves #36

This PR add 5 new roles for using Google's Material Design Icons as inline text. Each role represents a different material design "flavor":

• material-regular
• material-outlined
• material-sharp
• material-round
• material-twotone

Amongst all these flavors, there is a total of 10662 new icons provided. Instead of displaying them all, I defer users to browse Goggle's Material Design Icons showcase.

Includes updates to

• docs
• CSS (minified and SCSS)
• tests (pre/post XML files)
  • For some reason the pytests about myst icons-material-design.xml fails. I suspect it has something to do with the bullets in the bullet list in the docs/snippets/myst/icons-material-design.txt or just a difference in LF vs CRLF (I develop in Windows - but also ran pytest in WSL ubuntu) 😕

---

Since the feature is working with the JSON files I programmatically generated from the google/material-design-icons repo, I set up a small repo to run a CI job that updates JSON files when needed.

[welcome]

Thanks for submitting your first pull request! You are awesome! 🤗

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! 🎉

[2bndy5]

I still have no idea what's wrong with the pytest for Myst icons-material-design.xml.

I've tried using * as the bullets in the list, but that didn't help. I've tried manually editing both (pre/post) xml to not include the bullet="-" in the bullet_list tag, but then it complains that it is missing. 🤔

I'm not sure what is going on with the line that is triggering the AssertionError

sphinx-design/tests/test_snippets.py

Line 102 in 629b868

file_regression.check(

[codecov-commenter]

Codecov Report

Merging #41 (b11618d) into main (63754db) will decrease coverage by 0.53%.
The diff coverage is 80.00%.

❗ Current head b11618d differs from pull request most recent head f25a905. Consider uploading reports for the commit f25a905 to get more accurate results

@@            Coverage Diff             @@
##             main      #41      +/-   ##
==========================================
- Coverage   88.82%   88.29%   -0.54%     
==========================================
  Files          10       10              
  Lines         859      914      +55     
==========================================
+ Hits          763      807      +44     
- Misses         96      107      +11     

Flag	Coverage Δ
pytests	88.29% <80.00%> (-0.54%)	⬇️

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

Impacted Files	Coverage Δ
sphinx_design/icons.py	78.52% <80.00%> (+0.74%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 63754db...f25a905. Read the comment docs.

[chrisjsewell]

Nice one cheers!

[welcome]

Congrats on your first merged pull request in this project! 🎉


Thank you for contributing, we are very proud of you! ❤️

[2bndy5]

I may submit updates (via PR) to the compiled jsons when I see significant changes to the material icons repo. These updates may come without a linked issue though.

[chrisjsewell]

Sounds good ta 👍

[chrisjsewell]

Just going through some of the other issues, then should have a release out soon

[2bndy5]

Any idea about ETA for next release?

I'm sorry this sounds impatient (there's really no need to rush), but I keep teasing this feature over on the sphinx-immaterial theme repo, so I'm very much looking forward to the next release. We're starting to consider an optional extra CSS that exports user-specified SVG's data (based on node.js pkgs - not google's src repo like this feature is) as CSS vars...

[chrisjsewell]

No that's fair, sorry I got side-tracked with other things, but will try to get this done within the week