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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-icon-0.2.2.tar.gz
  • Upload date:
  • Size: 949.0 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.2.tar.gz
Algorithm Hash digest
SHA256 d4361e96dbfe64d60481f2386f4986cb2e23716a968b130ceca01c25dcd63534
MD5 fe48911a4ae65e8f021f2f9fdfe8a804
BLAKE2b-256 52ab710717754aae8c598a9813f4268b5a63f05ef722635df9a98cb407ba89c7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_icon-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 955.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a985bf81077d0a79a7c166c16b6252f1e89bb3ad188ed89326a21bb334521105
MD5 c69ac442b89bd658c08db3293b73bfe0
BLAKE2b-256 59c64ae8d43a77ee30e4bad8dc691510aa413af0e75f403bcc4cb41eb3642fd2

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