A sphinx custom role to embed inline btn which is an icon in a guilabel in the latex and html outputs
Project Links
Meta
Author: Pierrick Rambaud
Requires Python: >=3.6.9
Classifiers
Development Status
- 5 - Production/Stable
Framework
- Sphinx :: Extension
Intended Audience
- Developers
Topic
- Documentation
- Utilities
License
- OSI Approved :: BSD License
Programming Language
- Python
- Python :: 3
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
Overview
sphinx-btn is a Sphinx extention to allow developers to use the 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.
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.
Please go to our doc 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. Meet our contributor.
