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.1.tar.gz (948.2 kB view details)

Uploaded Source

Built Distribution

sphinx_icon-0.2.1-py3-none-any.whl (955.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-icon-0.2.1.tar.gz.

File metadata

  • Download URL: sphinx-icon-0.2.1.tar.gz
  • Upload date:
  • Size: 948.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for sphinx-icon-0.2.1.tar.gz
Algorithm Hash digest
SHA256 cc9ab561ed8fe4b96cd954dd78de67dc86b08b2f1da9e3f957b89f4cd2b09b9c
MD5 8e398a0a4c63e8b7eca2e6868ab54aa2
BLAKE2b-256 b6267d01b57c39cbdfae6dc84b739374f77a76d43e5d45e4071d5f3e625cb369

See more details on using hashes here.

File details

Details for the file sphinx_icon-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: sphinx_icon-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 955.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for sphinx_icon-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 346fe73c17ebf4a0eea3161ff5b9d36798289cda1f29d824eadd6c7ede0e0ee6
MD5 335fe4965903681675d7caebffa3d751
BLAKE2b-256 afdb20018a2b7550d294744410c89fa35a439077f924f3506236fa76d7cb764d

See more details on using hashes here.

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