You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Kujiu 4236146717
Add alt text on roles
4 months ago
sphinx_fasvg Add alt text on roles 4 months ago
.gitignore Initial release 1 year ago
CHANGES Add alt text on roles 4 months ago
LICENSE Initial release 1 year ago
LICENSE-de Initial release 1 year ago
LICENSE-fr Initial release 1 year ago
LICENSE-nl Initial release 1 year ago
README.rst Add alt text on roles 4 months ago
setup.cfg Initial release 1 year ago
setup.py Add alt text on roles 4 months ago

README.rst

Fontawesome SVG for Sphinx

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.