nerv-project
/
sphinx_fasvg
8
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
8 Commits 1 Branch 0 Tags 60 KiB
Python 100%
Go to file
Kujiu 4587c8c17d
Sphinx 7.x and python3.11 support 		2023-08-03 15:32:01 +02:00
sphinx_fasvg Sphinx 7.x and python3.11 support 2023-08-03 15:32:01 +02:00
.gitignore Initial release 2020-05-19 15:35:17 +02:00
CHANGES Sphinx 7.x and python3.11 support 2023-08-03 15:32:01 +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 Sphinx 7.x and python3.11 support 2023-08-03 15:32:01 +02:00

README.rst

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

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>