| Name | sphinx_fasvg JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | A Sphinx fontawesome wrapper for SVG format |
| upload_time | 2023-08-11 20:52:46 |
| maintainer | kujiu, ptitgnu |
| docs_url | None |
| author | kujiu, ptitgnu |
| requires_python | >=3.8 |
| license | None |
| keywords |
sphinx
doc
theme
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Fontawesome SVG for Sphinx
==========================
Install the module :
.. code:: bash
python setup.py install
Download SVGs from fontawesome website. Configure it
in your `conf.py`:
.. code:: python
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:
.. code:: rst
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx_fasvg",
"maintainer": "kujiu, ptitgnu",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Nerv Project ASBL <contact@nerv-project.eu>",
"keywords": "sphinx,doc,theme",
"author": "kujiu, ptitgnu",
"author_email": "Nerv Project ASBL <contact@nerv-project.eu>",
"download_url": "https://files.pythonhosted.org/packages/5d/5c/35225fb7521a4162ced0001e49859931af2b1f0175c00475e6a53748644f/sphinx_fasvg-2.0.1.tar.gz",
"platform": null,
"description": "Fontawesome SVG for Sphinx\n==========================\n\nInstall the module :\n\n.. code:: bash\n\n python setup.py install\n\nDownload SVGs from fontawesome website. Configure it\nin your `conf.py`:\n\n.. code:: python\n\n fa_brands_path = '_static/fa/brands.svg'\n fa_regular_path = '_static/fa/regular.svg'\n fa_solid_path = '_static/fa/solid.svg'\n\nUse inline references for brands, regular or solid:\n\n.. code:: rst\n\n Display an icon, with no alt text and aria-hidden:\n\n :fab:`icon`\n :far:`icon`\n :fas:`icon`\n\n :fab:`icon[alt text]`\n :far:`icon[alt text]`\n :fas:`icon[alt text]`\n\n An icon with some attributes:\n\n .. far:: icon\n :class: myclass\n :id: myid\n :alt: alt text\n\n For links with fasvglink and icon name as classes.\n This can be used to create fancy social links\n\n :fablink:`icon: Text <url>`\n :farlink:`icon: Text <url>`\n :faslink:`icon: Text <url>`\n\n :fablink:`icon: Text[alt text] <url>`\n :farlink:`icon: Text[alt text] <url>`\n :faslink:`icon: Text[alt text] <url>`\n\n.. warning::\n\n Icon is not inserted in LaTeX document for now.\n It uses alt text for all builders except HTML and\n ePub.\n\nBy kujiu, EUPL 1.2 licence.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Sphinx fontawesome wrapper for SVG format",
"version": "2.0.1",
"project_urls": {
"changelog": "https://procrastinator.nerv-project.eu/nerv-project/sphinx_fasvg/raw/branch/main/CHANGES.rst",
"editor": "https://www.nerv-project.eu",
"homepage": "https://www.nerv-project.eu",
"issues": "https://procrastinator.nerv-project.eu/nerv-project/sphinx_fasvg/issues",
"repository": "https://procrastinator.nerv-project.eu/nerv-project/sphinx_fasvg"
},
"split_keywords": [
"sphinx",
"doc",
"theme"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "056560b90861869bc59c78e157e60118d42ae569be25644385f099ba746e389e",
"md5": "eedc3b21ee8ae850321b542610c883ee",
"sha256": "7a6fd4450c2a418f5bb9b24230cf6886362d531dfad1c53c062ea46966081952"
},
"downloads": -1,
"filename": "sphinx_fasvg-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eedc3b21ee8ae850321b542610c883ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25553,
"upload_time": "2023-08-11T20:52:44",
"upload_time_iso_8601": "2023-08-11T20:52:44.992563Z",
"url": "https://files.pythonhosted.org/packages/05/65/60b90861869bc59c78e157e60118d42ae569be25644385f099ba746e389e/sphinx_fasvg-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5d5c35225fb7521a4162ced0001e49859931af2b1f0175c00475e6a53748644f",
"md5": "63afe1cb531cbe356f310e24ddfdf1b5",
"sha256": "da4334856f121ae6c4d2c0dbef2c7d546d3dd3094d74d2a3201256d703b7c5a6"
},
"downloads": -1,
"filename": "sphinx_fasvg-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "63afe1cb531cbe356f310e24ddfdf1b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24258,
"upload_time": "2023-08-11T20:52:46",
"upload_time_iso_8601": "2023-08-11T20:52:46.570667Z",
"url": "https://files.pythonhosted.org/packages/5d/5c/35225fb7521a4162ced0001e49859931af2b1f0175c00475e6a53748644f/sphinx_fasvg-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-11 20:52:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx_fasvg"
}
