| Name | sphinx-carousel JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | |
| Summary | A Sphinx extension for creating slideshows using Bootstrap Carousels. |
| upload_time | 2022-05-23 21:29:30 |
| maintainer | |
| docs_url | None |
| author | Robpol86 |
| requires_python | >=3.6 |
| license | BSD-2-Clause |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sphinx-carousel
[![Github-CI][github-ci]][github-link]
[![Coverage Status][codecov-badge]][codecov-link]
[![Documentation Status][rtd-badge]][rtd-link]
[![Code style: black][black-badge]][black-link]
[![PyPI][pypi-badge]][pypi-link]
[github-ci]: https://github.com/Robpol86/sphinx-carousel/actions/workflows/ci.yml/badge.svg?branch=main
[github-link]: https://github.com/Robpol86/sphinx-carousel/actions/workflows/ci.yml
[codecov-badge]: https://codecov.io/gh/Robpol86/sphinx-carousel/branch/main/graph/badge.svg
[codecov-link]: https://codecov.io/gh/Robpol86/sphinx-carousel
[rtd-badge]: https://readthedocs.org/projects/sphinx-carousel/badge/?version=latest
[rtd-link]: https://sphinx-carousel.readthedocs.io/en/latest/?badge=latest
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]: https://github.com/ambv/black
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-carousel.svg
[pypi-link]: https://pypi.org/project/sphinx-carousel
A Sphinx extension for creating slideshows using
[Bootstrap 5 Carousels](https://getbootstrap.com/docs/5.1/components/carousel/).
📖 See the documentation at https://sphinx-carousel.readthedocs.io
## Install
Requires Python 3.6 or greater and Sphinx 4.0 or greater.
```shell
pip install sphinx-carousel
```
## Example
```python
# conf.py
extensions = [
"sphinx_carousel.carousel",
]
```
```rst
===============
An RST Document
===============
.. carousel::
.. image:: https://i.imgur.com/fmJnevTl.jpg
:target: https://i.imgur.com/fmJnevT.jpg
.. image:: https://i.imgur.com/ppGH90Jl.jpg
.. figure:: https://i.imgur.com/fWyn9A2l.jpg
An Example Image
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut
labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris
nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit
esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt
in culpa qui officia deserunt mollit anim id est laborum.
```
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-carousel",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Robpol86",
"author_email": "robpol86@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a6/45/c4386c065e7da79370fc313f805b5165bc603a6eb7049846cde86c91c9dc/sphinx-carousel-1.2.0.tar.gz",
"platform": null,
"description": "# sphinx-carousel\n\n[![Github-CI][github-ci]][github-link]\n[![Coverage Status][codecov-badge]][codecov-link]\n[![Documentation Status][rtd-badge]][rtd-link]\n[![Code style: black][black-badge]][black-link]\n[![PyPI][pypi-badge]][pypi-link]\n\n[github-ci]: https://github.com/Robpol86/sphinx-carousel/actions/workflows/ci.yml/badge.svg?branch=main\n[github-link]: https://github.com/Robpol86/sphinx-carousel/actions/workflows/ci.yml\n[codecov-badge]: https://codecov.io/gh/Robpol86/sphinx-carousel/branch/main/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/Robpol86/sphinx-carousel\n[rtd-badge]: https://readthedocs.org/projects/sphinx-carousel/badge/?version=latest\n[rtd-link]: https://sphinx-carousel.readthedocs.io/en/latest/?badge=latest\n[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg\n[black-link]: https://github.com/ambv/black\n[pypi-badge]: https://img.shields.io/pypi/v/sphinx-carousel.svg\n[pypi-link]: https://pypi.org/project/sphinx-carousel\n\nA Sphinx extension for creating slideshows using\n[Bootstrap 5 Carousels](https://getbootstrap.com/docs/5.1/components/carousel/).\n\n\ud83d\udcd6 See the documentation at https://sphinx-carousel.readthedocs.io\n\n## Install\n\nRequires Python 3.6 or greater and Sphinx 4.0 or greater.\n\n```shell\npip install sphinx-carousel\n```\n\n## Example\n\n```python\n# conf.py\nextensions = [\n \"sphinx_carousel.carousel\",\n]\n```\n\n```rst\n===============\nAn RST Document\n===============\n\n.. carousel::\n\n .. image:: https://i.imgur.com/fmJnevTl.jpg\n :target: https://i.imgur.com/fmJnevT.jpg\n .. image:: https://i.imgur.com/ppGH90Jl.jpg\n .. figure:: https://i.imgur.com/fWyn9A2l.jpg\n\n An Example Image\n\n Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut\n labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris\n nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit\n esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt\n in culpa qui officia deserunt mollit anim id est laborum.\n\n```\n\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "A Sphinx extension for creating slideshows using Bootstrap Carousels.",
"version": "1.2.0",
"project_urls": {
"documentation": "https://sphinx-carousel.readthedocs.io",
"repository": "https://github.com/Robpol86/sphinx-carousel"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f117ba46d25e59325139a1d6127a0d3879e6af76e6669ad77284b519ec96441c",
"md5": "4da4eab4123d5373144481d1e8ecd097",
"sha256": "3e3e5dda44fc99de9d37f15ef1669356a21ce9e536e7e359d29ca39398ef9502"
},
"downloads": -1,
"filename": "sphinx_carousel-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4da4eab4123d5373144481d1e8ecd097",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 25617,
"upload_time": "2022-05-23T21:29:29",
"upload_time_iso_8601": "2022-05-23T21:29:29.481410Z",
"url": "https://files.pythonhosted.org/packages/f1/17/ba46d25e59325139a1d6127a0d3879e6af76e6669ad77284b519ec96441c/sphinx_carousel-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a645c4386c065e7da79370fc313f805b5165bc603a6eb7049846cde86c91c9dc",
"md5": "a6f98eb1d2e3cdd1009cf3e2f6622744",
"sha256": "4cb4142c9b4334fee9973dd352f018da7a0729a65a4305079a400f3ec8f49804"
},
"downloads": -1,
"filename": "sphinx-carousel-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a6f98eb1d2e3cdd1009cf3e2f6622744",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 25208,
"upload_time": "2022-05-23T21:29:30",
"upload_time_iso_8601": "2022-05-23T21:29:30.735518Z",
"url": "https://files.pythonhosted.org/packages/a6/45/c4386c065e7da79370fc313f805b5165bc603a6eb7049846cde86c91c9dc/sphinx-carousel-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-05-23 21:29:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Robpol86",
"github_project": "sphinx-carousel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-carousel"
}
