Skip to main content
License: BSD 2-Clause PyPI supported Python version GitHub Workflow Status Codecov Read the Docs Black badge conventional commit

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.
demo result

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.

Metadata

Release files for sphinx-btn 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-btn 0.1.2
File Size Uploaded
sphinx-btn-0.1.2.tar.gz 5.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-btn 0.1.2
File Interpreter ABI Platform
sphinx_btn-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 11.0 kB

Release files / sphinx-btn-0.1.2.tar.gz

Download URL sphinx-btn-0.1.2.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b62b5d6caa785c4d7e79467965e3bd0e6b7658758afad02d2ab459cde2a42828
BLAKE2b-256 checksum
How to use checksums
899983086d668b8f5216c725488bf52325a16d3e2af66dbbedd382a3dce8eac5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Release files / sphinx_btn-0.1.2-py3-none-any.whl

Download URL sphinx_btn-0.1.2-py3-none-any.whl
Size 5.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a8081473b6c71488a96b132853e86a66957d3786db7521a5b5a68f9e997f95de
BLAKE2b-256 checksum
How to use checksums
817bcdb47db90d7eb3a9fb4a888d93a7795533c9140e86fbc2cb6bd0d5af23ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

0.1.1

2 release files

0.1.0

1 release file

0.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page