From 0bc1ec4878a4d66fa69dd0dc6fb1f3f3bfaea607 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio=20=28Lunar=29?=
<lunar@softwareheritage.org>
Date: Wed, 31 May 2023 14:55:55 +0200
Subject: [PATCH] Add support for slideshows using sphinx-carousel
sphinx-carousel is a Sphinx extension for creating slideshows using
Bootstrap carousels. The extension supports the PyData Sphinx theme that
we are currently using.
This would be a nice addition to show the various steps of an algorithm
in swh-alter documentation.
See: https://sphinx-carousel.readthedocs.io/ and
https://getbootstrap.com/docs/5.1/components/carousel/
---
requirements.txt | 1 +
swh/docs/sphinx/conf.py | 1 +
2 files changed, 2 insertions(+)
diff --git a/requirements.txt b/requirements.txt
index 5fd1d863..1ffcb521 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,6 +5,7 @@ sphinx
sphinxcontrib-httpdomain >= 1.8.0
sphinxcontrib-images
sphinxcontrib-programoutput
+sphinx-carousel
sphinx-design
sphinx-reredirects
pydata-sphinx-theme
diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py
index 704b7fee..382b60bd 100755
--- a/swh/docs/sphinx/conf.py
+++ b/swh/docs/sphinx/conf.py
@@ -42,6 +42,7 @@ extensions = [
# swh.scheduler inherits some attribute descriptions from celery that use
# custom crossrefs (eg. :setting:`task_ignore_result`)
"sphinx_celery.setting_crossref",
+ "sphinx_carousel.carousel",
"sphinx_design",
]
--
GitLab