Skip to main content

A Sphinx fontawesome wrapper for SVG format

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>`

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.

Source Distribution

sphinx_fasvg-2.0.1.tar.gz (24.3 kB view hashes)

Uploaded Source

Built Distribution

sphinx_fasvg-2.0.1-py3-none-any.whl (25.6 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