Skip to main content

Use font-awesome icons in SVG form

Project description

Install the module :

python setup.py install

Download SVGs from fontawesome website. Configure it in your conf.py:

fa_brands_path = '_static/fa/brands.svg'
fa_regular_path = '_static/fa/regular.svg'
fa_solid_path = '_static/fa/solid.svg'

Use inline references for brands, regular or solid:

Display an icon, with no alt text and aria-hidden:

:fab:`icon`
:far:`icon`
:fas:`icon`

:fab:`icon[alt text]`
:far:`icon[alt text]`
:fas:`icon[alt text]`

An icon with some attributes:

.. far:: icon
   :class: myclass
   :id: myid
   :alt: alt text

For links with fasvglink and icon name as classes.
This can be used to create fancy social links

:fablink:`icon: Text <url>`
:farlink:`icon: Text <url>`
:faslink:`icon: Text <url>`

:fablink:`icon: Text[alt text] <url>`
:farlink:`icon: Text[alt text] <url>`
:faslink:`icon: Text[alt text] <url>`

Warning

Icon is not inserted in LaTeX document for now. It uses alt text for all builders except HTML and ePub.

By kujiu, EUPL 1.2 licence.

Project details


Download files

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

Files for sphinx-fasvg, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_fasvg-1.0.0.tar.gz (23.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page