Go to file

Kujiu 7fa7573977 Version number only in pyproject.toml		2023-08-11 22:52:21 +02:00
sphinx_fasvg	Version number only in pyproject.toml	2023-08-11 22:52:21 +02:00
.gitignore	Initial release	2020-05-19 15:35:17 +02:00
CHANGES	Version number only in pyproject.toml	2023-08-11 22:52:21 +02:00
LICENSE	Initial release	2020-05-19 15:35:17 +02:00
LICENSE-de	Initial release	2020-05-19 15:35:17 +02:00
LICENSE-fr	Initial release	2020-05-19 15:35:17 +02:00
LICENSE-nl	Initial release	2020-05-19 15:35:17 +02:00
README.rst	Add alt text on roles	2021-06-06 18:50:29 +02:00
pyproject.toml	Version number only in pyproject.toml	2023-08-11 22:52:21 +02:00

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

By kujiu, EUPL 1.2 licence.

</html>