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.0.tar.gz
(24.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_fasvg-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a74d9b17793f0f4dae12b8e98f143ff73f6b26ae2c46465eae157bef11ba2524 |
|
MD5 | bedf0776a614c11b7d386b8593be7686 |
|
BLAKE2b-256 | f4f7a7e4324502b3851952eceb9a52a86ae262e8238c5c0f5654b757d699511e |