sphinx-inline-tabs

Name	sphinx-inline-tabs JSON
Version	2023.4.21 JSON
	download
home_page	https://github.com/pradyunsg/sphinx-inline-tabs
Summary	Add inline tabbed content to your Sphinx documentation.
upload_time	2023-04-21 20:25:30
maintainer
docs_url	None
author	Pradyun Gedam
requires_python	>=3.8
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Sphinx Inline Tabs

![demo image](https://raw.githubusercontent.com/pradyunsg/sphinx-inline-tabs/main/docs/_static/demo.png)

<!-- start-include-here -->

Add inline tabbed content to your Sphinx documentation.

## Installation

This project is available on PyPI, and can be installed using pip:

```
pip install sphinx-inline-tabs
```

You'll also want to add the extension to `extensions` in `conf.py`:

```python
extensions = [
    ...,
    "sphinx_inline_tabs",
    ...,
]
```

## Features

- **Elegant design**: Small footprint in the markup and generated website, while looking good.
- **Configurable**: All the colors can be configured using CSS variables.
- **Synchronisation**: Tabs with the same label all switch with a single click.
- **Works without JavaScript**: JavaScript is not required for the basics, only for synchronisation.

<!-- end-include-here -->

## Contributing

sphinx-inline-tabs is a volunteer maintained open source project, and we welcome contributions of all forms.

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.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pradyunsg/sphinx-inline-tabs",
    "name": "sphinx-inline-tabs",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Pradyun Gedam",
    "author_email": "mail@pradyunsg.me",
    "download_url": "https://files.pythonhosted.org/packages/48/f5/f8a2be63ed7be9f91a4c2bea0e25bcb56aa4c5cc37ec4d8ead8065f926b1/sphinx_inline_tabs-2023.4.21.tar.gz",
    "platform": null,
    "description": "# Sphinx Inline Tabs\n\n![demo image](https://raw.githubusercontent.com/pradyunsg/sphinx-inline-tabs/main/docs/_static/demo.png)\n\n<!-- start-include-here -->\n\nAdd inline tabbed content to your Sphinx documentation.\n\n## Installation\n\nThis project is available on PyPI, and can be installed using pip:\n\n```\npip install sphinx-inline-tabs\n```\n\nYou'll also want to add the extension to `extensions` in `conf.py`:\n\n```python\nextensions = [\n    ...,\n    \"sphinx_inline_tabs\",\n    ...,\n]\n```\n\n## Features\n\n- **Elegant design**: Small footprint in the markup and generated website, while looking good.\n- **Configurable**: All the colors can be configured using CSS variables.\n- **Synchronisation**: Tabs with the same label all switch with a single click.\n- **Works without JavaScript**: JavaScript is not required for the basics, only for synchronisation.\n\n<!-- end-include-here -->\n\n## Contributing\n\nsphinx-inline-tabs is a volunteer maintained open source project, and we welcome contributions of all forms.\n\nThe [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.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Add inline tabbed content to your Sphinx documentation.",
    "version": "2023.4.21",
    "project_urls": {
        "Homepage": "https://github.com/pradyunsg/sphinx-inline-tabs"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d601e4c9017d722b9c7731abc11f39ac8b083b479fbcefe12015b57e457a296",
                "md5": "7373d0ebd34be8f9ac2ed62bc63f4582",
                "sha256": "06809ac613f7c48ddd6e2fa588413e3fe92cff2397b56e2ccf0b0218f9ef6a78"
            },
            "downloads": -1,
            "filename": "sphinx_inline_tabs-2023.4.21-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7373d0ebd34be8f9ac2ed62bc63f4582",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6850,
            "upload_time": "2023-04-21T20:25:28",
            "upload_time_iso_8601": "2023-04-21T20:25:28.778974Z",
            "url": "https://files.pythonhosted.org/packages/9d/60/1e4c9017d722b9c7731abc11f39ac8b083b479fbcefe12015b57e457a296/sphinx_inline_tabs-2023.4.21-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "48f5f8a2be63ed7be9f91a4c2bea0e25bcb56aa4c5cc37ec4d8ead8065f926b1",
                "md5": "8ad2ed91257b0199553357d4d9627742",
                "sha256": "5df2f13f602c158f3f5f6c509e008aeada199a8c76d97ba3aa2822206683bebc"
            },
            "downloads": -1,
            "filename": "sphinx_inline_tabs-2023.4.21.tar.gz",
            "has_sig": false,
            "md5_digest": "8ad2ed91257b0199553357d4d9627742",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 42664,
            "upload_time": "2023-04-21T20:25:30",
            "upload_time_iso_8601": "2023-04-21T20:25:30.578747Z",
            "url": "https://files.pythonhosted.org/packages/48/f5/f8a2be63ed7be9f91a4c2bea0e25bcb56aa4c5cc37ec4d8ead8065f926b1/sphinx_inline_tabs-2023.4.21.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-21 20:25:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pradyunsg",
    "github_project": "sphinx-inline-tabs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "sphinx-inline-tabs"
}