Skip to main content

sphinx-carousel

Github-CI Coverage Status Documentation Status Code style: black PyPI

A Sphinx extension for creating slideshows using Bootstrap 5 Carousels.

📖 See the documentation at https://sphinx-carousel.readthedocs.io

Install

Requires Python 3.6 or greater and Sphinx 4.0 or greater.

pip install sphinx-carousel

Example

# conf.py
extensions = [
    "sphinx_carousel.carousel",
]
===============
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.

Metadata

Release files for sphinx-carousel 1.2.0

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-carousel 1.2.0
File Size Uploaded
sphinx-carousel-1.2.0.tar.gz 25.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-carousel 1.2.0
File Interpreter ABI Platform
sphinx_carousel-1.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 50.8 kB

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.0.2

2 release files

0.0.1

2 release files

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