Sphinx Carousel

A Sphinx extension for creating slideshows using Bootstrap carousels.

Project Links

• Documentation: https://sphinx-carousel.readthedocs.io

• Source code: https://github.com/Robpol86/sphinx-carousel

• PyPI homepage: https://pypi.org/project/sphinx-carousel

Contents

• Getting Started
  • Install
  • Enable
  • Configuration
• Usage
  • Linked Images
  • Captions Without Titles
• Native Features
  • Controls
  • Indicators
  • Crossfade
  • Dark Mode
  • Additional Options
    • Interval
    • Keyboard, Touch, Wrap
    • Pause, Ride
• Extended Features
  • Captions Below
  • Shadows
    • With Dark Mode
  • Buttons on Top

Supported Themes

• Read the Docs
• PyData Sphinx Theme
• Sphinx Book Theme