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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx-btn-0.1.1.tar.gz.
File metadata
- Download URL: sphinx-btn-0.1.1.tar.gz
- Upload date:
- Size: 5.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2668963cf4a0b42a9eb53422e349830bc5df75e7daca55f3b2b4582f484142cb |
|
| MD5 | 7186d32457213b8f401b6cff6723d12c |
|
| BLAKE2b-256 | c456b803d4bb2fabd3d0aa64ee93d74cd5a6efe55a6ae08036a4c5de657624f2 |
File details
Details for the file sphinx_btn-0.1.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_btn-0.1.1-py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d007358008be850a24a982e5e61a3fd524a73bb862362a840f43bf1798f1643f |
|
| MD5 | cbff2f2a1b069f2d50a2c997ee66f666 |
|
| BLAKE2b-256 | ec114711b7536b0ed68858364c022261eba6d091637e4040e4ac0f473c4daa98 |
