Skip to main content

A sphinx custom role to embed inline fontawesome incon in the latex and html outputs

Project description

License: BSD 2-Clause PyPI supported Python version GitHub Workflow Status Codecov Read the Docs Black badge conventional commit

Overview

sphinx-icon is a Sphinx extention to allow developers to use the icon role to display inlined icons. The extention currently supports only Fontawsome 6.3.0 icons.

I'm an :icon:`fa-solid fa-folder` icon.
I'm an :icon:`fa-regular fa-user` icon.
I'm an :icon:`fa-brands fa-500px` icon.
demo result

Please go to our doc if you want to know more.

Contribute

If you want to contribute you can fork the project in you own repository and then use it. If you consider working with us, please follow the contributing guidelines. Meet our contributor.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-icon-0.2.2.tar.gz (949.0 kB view hashes)

Uploaded Source

Built Distribution

sphinx_icon-0.2.2-py3-none-any.whl (955.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page