Add hyper role, to render hyperlinks with style

[amotl]

About

An element to render hyperlinks, based on foundational components coming from sphinx{design}. It implements the Sphinx role hyper.

Preview

https://sphinx-design-elements--71.org.readthedocs.build/en/71/hyper.html

Details

• The hyper role builds upon and extends the semantics and implementation of the ref/xref roles/machinery.
• It is based on the components badge, button, card, and shield.
  • Badges, Buttons, and Cards are from sphinx{design}.
  • Shields are from Shields.io, unlocked per Add shield directive, to render badges through Shields.io #69.
• Currently, it exclusively compiles to MyST Markdown. reStructuredText is not supported yet, and support will only be added based on community interest, if possible at all.

Usage

Markdown

{hyper}`https://example.org`

reStructuredText

:hyper:`https://example.org`

References

• MEP 0002 - Cross Reference Simplifications using Markdown Links
• Make intersphinx (a.k.a. external references) more user friendly
• Add a new references builder sphinx-doc/sphinx#12190

[codecov]

Codecov Report

Attention: Patch coverage is 94.48622% with 22 lines in your changes are missing coverage. Please review.

Project coverage is 94.71%. Comparing base (c675d47) to head (1169e80).
Report is 1 commits behind head on main.

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

Files	Patch %	Lines
sphinx_design_elements/hyper.py	96.01%	9 Missing ⚠️
sphinx_design_elements/util/role.py	83.67%	8 Missing ⚠️
sphinx_design_elements/shield.py	91.52%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #71      +/-   ##
==========================================
- Coverage   95.21%   94.71%   -0.50%     
==========================================
  Files           6       10       +4     
  Lines         188      587     +399     
==========================================
+ Hits          179      556     +377     
- Misses          9       31      +22     

Flag	Coverage Δ
unittests	94.71% <94.48%> (-0.50%)	⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[amotl]

Dear @chrisjsewell,

may we humbly ask you to have a look at this, specifically the syntax extensions of the new hyper role on behalf of its documentation, and convey corresponding feedback if you think this is totally silly or not?

We don't have so many capacities in our community to review Sphinx-related details, that is why we are approaching you about it, also because this machinery significantly builds upon your great work at sphinx-design. ✨

Thank you very much in advance. 🙏

With kind regards,
Andreas.