| Name | sphinx-btn JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | |
| Summary | A sphinx custom role to embed inline btn which is an icon in a guilabel in the latex and html outputs |
| upload_time | 2023-03-14 13:42:40 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6.9 |
| license | BSD 2-Clause |
| keywords |
python
fontawesome
sphinx
extention
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
sphinx-btn
===========
.. image:: https://img.shields.io/badge/License-BSD_2--Clause-yellow.svg
:target: https://github.com/sphinx-contrib/btn/blob/main/LICENSE
:alt: License: BSD 2-Clause
.. image:: https://img.shields.io/pypi/v/sphinx-btn?logo=python&logoColor=white&color=blue
:target: https://pypi.org/project/sphinx-btn/
:alt: PyPI
.. image:: https://img.shields.io/pypi/pyversions/sphinx-btn?logo=python&logoColor=white&color=blue
:target: https://pypi.org/project/sphinx-btn/
:alt: supported Python version
.. image:: https://img.shields.io/github/actions/workflow/status/sphinx-contrib/btn/unit.yml?logo=github&logoColor=white
:target: https://github.com/sphinx-contrib/btn/actions/workflows/unit.yml
:alt: GitHub Workflow Status
.. image:: https://img.shields.io/codecov/c/github/sphinx-contrib/btn?logo=codecov&logoColor=white
:target: https://codecov.io/gh/sphinx-contrib/btn
:alt: Codecov
.. image:: https://img.shields.io/readthedocs/sphinx-btn?logo=readthedocs&logoColor=white
:target: https://sphinx-btn.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black badge
.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
:target: https://conventionalcommits.org
:alt: conventional commit
Overview
--------
:code:`sphinx-btn` is a Sphinx extention to allow developers to use the :code:`btn` role to display inlined btn in their documentation. A btn is composed of an icon and/or some text.
The extention currently supports only Fontawsome 6.3.0 icons.
.. code-block:: rst
I'm a :btn:`<fa-solid fa-folder> fa-folder` btn.
I'm a :btn:`<fa-solid fa-folder>` btn.
I'm a :btn:`fa-folder` btn.
.. image:: https://raw.githubusercontent.com/sphinx-contrib/btn/main/docs/_static/demo.png
:alt: demo result
Please go to our `doc <https://sphinx-btn.readthedocs.io/en/latest/>`__ if you want to know more.
Contribute
----------
If you want to contribute you can fork the project in you own repository and then use it.
If you consider working with us, please follow the `contributing guidelines <https://github.com/sphinx-contrib/btn/blob/main/CONTRIBUTING.rst>`__.
Meet our `contributor <https://github.com/sphinx-contrib/btn/blob/main/AUTHORS.rst>`__.
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-btn",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.9",
"maintainer_email": "",
"keywords": "python,fontawesome,sphinx,extention",
"author": "",
"author_email": "Pierrick Rambaud <pierrick.rambaud49@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/89/99/83086d668b8f5216c725488bf52325a16d3e2af66dbbedd382a3dce8eac5/sphinx-btn-0.1.2.tar.gz",
"platform": null,
"description": "sphinx-btn\n===========\n\n.. image:: https://img.shields.io/badge/License-BSD_2--Clause-yellow.svg\n :target: https://github.com/sphinx-contrib/btn/blob/main/LICENSE\n :alt: License: BSD 2-Clause\n\n.. image:: https://img.shields.io/pypi/v/sphinx-btn?logo=python&logoColor=white&color=blue\n :target: https://pypi.org/project/sphinx-btn/\n :alt: PyPI\n\n.. image:: https://img.shields.io/pypi/pyversions/sphinx-btn?logo=python&logoColor=white&color=blue\n :target: https://pypi.org/project/sphinx-btn/\n :alt: supported Python version\n\n.. image:: https://img.shields.io/github/actions/workflow/status/sphinx-contrib/btn/unit.yml?logo=github&logoColor=white\n :target: https://github.com/sphinx-contrib/btn/actions/workflows/unit.yml\n :alt: GitHub Workflow Status\n\n.. image:: https://img.shields.io/codecov/c/github/sphinx-contrib/btn?logo=codecov&logoColor=white\n :target: https://codecov.io/gh/sphinx-contrib/btn\n :alt: Codecov\n\n.. image:: https://img.shields.io/readthedocs/sphinx-btn?logo=readthedocs&logoColor=white\n :target: https://sphinx-btn.readthedocs.io/en/latest/?badge=latest\n :alt: Read the Docs\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black badge\n\n.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg\n :target: https://conventionalcommits.org\n :alt: conventional commit\n\nOverview\n--------\n\n:code:`sphinx-btn` is a Sphinx extention to allow developers to use the :code:`btn` role to display inlined btn in their documentation. A btn is composed of an icon and/or some text.\nThe extention currently supports only Fontawsome 6.3.0 icons.\n\n.. code-block:: rst\n\n I'm a :btn:`<fa-solid fa-folder> fa-folder` btn.\n I'm a :btn:`<fa-solid fa-folder>` btn.\n I'm a :btn:`fa-folder` btn.\n\n.. image:: https://raw.githubusercontent.com/sphinx-contrib/btn/main/docs/_static/demo.png\n :alt: demo result\n\nPlease go to our `doc <https://sphinx-btn.readthedocs.io/en/latest/>`__ if you want to know more.\n\nContribute\n----------\n\nIf you want to contribute you can fork the project in you own repository and then use it.\nIf you consider working with us, please follow the `contributing guidelines <https://github.com/sphinx-contrib/btn/blob/main/CONTRIBUTING.rst>`__.\nMeet our `contributor <https://github.com/sphinx-contrib/btn/blob/main/AUTHORS.rst>`__.\n",
"bugtrack_url": null,
"license": "BSD 2-Clause",
"summary": "A sphinx custom role to embed inline btn which is an icon in a guilabel in the latex and html outputs",
"version": "0.1.2",
"split_keywords": [
"python",
"fontawesome",
"sphinx",
"extention"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "817bcdb47db90d7eb3a9fb4a888d93a7795533c9140e86fbc2cb6bd0d5af23ba",
"md5": "7423bdcde4a7db98c2169d348d337007",
"sha256": "a8081473b6c71488a96b132853e86a66957d3786db7521a5b5a68f9e997f95de"
},
"downloads": -1,
"filename": "sphinx_btn-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7423bdcde4a7db98c2169d348d337007",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.9",
"size": 5163,
"upload_time": "2023-03-14T13:42:38",
"upload_time_iso_8601": "2023-03-14T13:42:38.681398Z",
"url": "https://files.pythonhosted.org/packages/81/7b/cdb47db90d7eb3a9fb4a888d93a7795533c9140e86fbc2cb6bd0d5af23ba/sphinx_btn-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "899983086d668b8f5216c725488bf52325a16d3e2af66dbbedd382a3dce8eac5",
"md5": "9f8628b136bf12da2f0d96a66194d6dc",
"sha256": "b62b5d6caa785c4d7e79467965e3bd0e6b7658758afad02d2ab459cde2a42828"
},
"downloads": -1,
"filename": "sphinx-btn-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "9f8628b136bf12da2f0d96a66194d6dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.9",
"size": 5876,
"upload_time": "2023-03-14T13:42:40",
"upload_time_iso_8601": "2023-03-14T13:42:40.697065Z",
"url": "https://files.pythonhosted.org/packages/89/99/83086d668b8f5216c725488bf52325a16d3e2af66dbbedd382a3dce8eac5/sphinx-btn-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-14 13:42:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "sphinx-btn"
}
