| 1 |
Metadata-Version: 2.1 |
| 2 |
Name: sphinx_inline_tabs |
| 3 |
Version: 2023.4.21 |
| 4 |
Summary: Add inline tabbed content to your Sphinx documentation. |
| 5 |
Home-page: https://github.com/pradyunsg/sphinx-inline-tabs |
| 6 |
Author: Pradyun Gedam |
| 7 |
Author-email: [email protected] |
| 8 |
Requires-Python: >=3.8 |
| 9 |
Description-Content-Type: text/markdown |
| 10 |
Requires-Dist: sphinx >= 3 |
| 11 |
Requires-Dist: myst-parser ; extra == "doc" |
| 12 |
Requires-Dist: furo ; extra == "doc" |
| 13 |
Requires-Dist: pytest ; extra == "test" |
| 14 |
Requires-Dist: pytest-cov ; extra == "test" |
| 15 |
Requires-Dist: pytest-xdist ; extra == "test" |
| 16 |
Provides-Extra: doc |
| 17 |
Provides-Extra: test |
| 18 |
|
| 19 |
# Sphinx Inline Tabs |
| 20 |
|
| 21 |
 |
| 22 |
|
| 23 |
<!-- start-include-here --> |
| 24 |
|
| 25 |
Add inline tabbed content to your Sphinx documentation. |
| 26 |
|
| 27 |
## Installation |
| 28 |
|
| 29 |
This project is available on PyPI, and can be installed using pip: |
| 30 |
|
| 31 |
``` |
| 32 |
pip install sphinx-inline-tabs |
| 33 |
``` |
| 34 |
|
| 35 |
You'll also want to add the extension to `extensions` in `conf.py`: |
| 36 |
|
| 37 |
```python |
| 38 |
extensions = [ |
| 39 |
..., |
| 40 |
"sphinx_inline_tabs", |
| 41 |
..., |
| 42 |
] |
| 43 |
``` |
| 44 |
|
| 45 |
## Features |
| 46 |
|
| 47 |
- **Elegant design**: Small footprint in the markup and generated website, while looking good. |
| 48 |
- **Configurable**: All the colors can be configured using CSS variables. |
| 49 |
- **Synchronisation**: Tabs with the same label all switch with a single click. |
| 50 |
- **Works without JavaScript**: JavaScript is not required for the basics, only for synchronisation. |
| 51 |
|
| 52 |
<!-- end-include-here --> |
| 53 |
|
| 54 |
## Contributing |
| 55 |
|
| 56 |
sphinx-inline-tabs is a volunteer maintained open source project, and we welcome contributions of all forms. |
| 57 |
|
| 58 |
The [Code of Conduct](CODE_OF_CONDUCT.md) applies within all community spaces. If you are not familiar with our Code of Conduct policy, take a minute to read the policy before starting with your first contribution. |
| 59 |
|