| Name | sphinx-fasvg JSON |
| Version |
2.0.2
JSON |
| download |
| home_page | None |
| Summary | A Sphinx fontawesome wrapper for SVG format |
| upload_time | 2024-07-29 12:45:35 |
| 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/a2/98/461d5cbde7cfc3b0c917a550b1fae0e5b3cd6bacd4eeef58e642e8ffb875/sphinx_fasvg-2.0.2.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\n",
"bugtrack_url": null,
"license": null,
"summary": "A Sphinx fontawesome wrapper for SVG format",
"version": "2.0.2",
"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": "",
"digests": {
"blake2b_256": "bf00803a4b6186d9021bb5a0025d7c75eb1a1122ac0fdbe33eaee2b9cd1273e7",
"md5": "81e110a2c3490923572210a071a6b0bb",
"sha256": "2be709c5139f7a17112dc6a9252cb67a4da78809d6fcebb1e8136943a915bd71"
},
"downloads": -1,
"filename": "sphinx_fasvg-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81e110a2c3490923572210a071a6b0bb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25548,
"upload_time": "2024-07-29T12:45:34",
"upload_time_iso_8601": "2024-07-29T12:45:34.235005Z",
"url": "https://files.pythonhosted.org/packages/bf/00/803a4b6186d9021bb5a0025d7c75eb1a1122ac0fdbe33eaee2b9cd1273e7/sphinx_fasvg-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a298461d5cbde7cfc3b0c917a550b1fae0e5b3cd6bacd4eeef58e642e8ffb875",
"md5": "f94ceb79b32efae5587e905da75747ff",
"sha256": "42d167d16e7a8407b4f7745a1013b1131237d5538af680ce1ee887170fc1b5fa"
},
"downloads": -1,
"filename": "sphinx_fasvg-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "f94ceb79b32efae5587e905da75747ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24256,
"upload_time": "2024-07-29T12:45:35",
"upload_time_iso_8601": "2024-07-29T12:45:35.992422Z",
"url": "https://files.pythonhosted.org/packages/a2/98/461d5cbde7cfc3b0c917a550b1fae0e5b3cd6bacd4eeef58e642e8ffb875/sphinx_fasvg-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 12:45:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-fasvg"
}
