Metadata-Version: 2.1
Name: sphinx-btn
Version: 0.0.0
Summary: A sphinx custom role to embed inline btn which is an icon in a guilabel in the latex and html outputs
Home-page: https://github.com/12rambau/sphinx-btn
Author: Pierrick Rambaud
Author-email: pierrick.rambaud49@gmail.com
License: BSD 2-Clause
Download-URL: https://github.com/12rambau/shpinx-btn/archive/v0.0.0.tar.gz
Description: Sphinx-Btn
        ===========
        
        .. image:: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat
            :alt: All contributors
            :target: AUTHORS.rst
        
        .. image:: https://img.shields.io/badge/License-BSD_2--Clause-orange.svg
            :target: LICENSE
            :alt: License: BSD 2-Clause
        
        .. image:: https://badge.fury.io/py/sphinx-btn.svg
            :target: https://badge.fury.io/py/sphinx-btn
            :alt: PyPI version
            
        .. image:: https://img.shields.io/pypi/dm/sphinx-btn?color=307CC2&logo=python&logoColor=gainsboro  
            :target: https://pypi.org/project/sphinx-btn/
            :alt: PyPI - Downloads
            
        .. image:: https://img.shields.io/pypi/pyversions/sphinx-btn
           :target: https://pypi.org/project/sphinx-btn/
           :alt: supported Python version
        
        .. image:: https://github.com/12rambau/sphinx-btn/actions/workflows/unit.yml/badge.svg
            :target: https://github.com/12rambau/sphinx-btn/actions/workflows/unit.yml
            :alt: build
        
        .. image:: https://codecov.io/gh/12rambau/sphinx-btn/branch/main/graph/badge.svg?token=NSdnY0hJpF
            :target: https://codecov.io/gh/12rambau/sphinx-btn
            :alt: Test Coverage
            
        .. image:: https://readthedocs.org/projects/sphinx-btn/badge/?version=latest
            :target: https://sphinx-btn.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
            
        .. 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 5.15.4 icons.
        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/12rambau/sphinx-btn/blob/main/CONTRIBUTING.rst>`__. 
        Meet our `contributor <https://github.com/12rambau/sphinx-btn/blob/main/AUTHORS.rst>`__. 
        
Keywords: skeleton,Python
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6.9
Description-Content-Type: text/x-rst
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: doc
