A sphinx custom role to embed inline btn which is an icon in a guilabel in the latex and html outputs
Project description
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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx-btn-0.1.2.tar.gz
(5.9 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_btn-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8081473b6c71488a96b132853e86a66957d3786db7521a5b5a68f9e997f95de |
|
MD5 | 7423bdcde4a7db98c2169d348d337007 |
|
BLAKE2b-256 | 817bcdb47db90d7eb3a9fb4a888d93a7795533c9140e86fbc2cb6bd0d5af23ba |