doc: replace sphinx panels with sphinx design (its successor)

This unblocks the sphinx < 5 version constraint from sphinx panels
andresailer · Jul 28, 2023 · b59a37f · b59a37f
1 parent 5e5b1af
commit b59a37f
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 40 deletions.
diff --git a/docs/setup.py b/docs/setup.py
@@ -29,5 +29,5 @@
     package_dir=PACKAGE_DIR,
     packages=ALL_PACKAGES,
     scripts=SCRIPTS,
-    install_requires=["sphinx_rtd_theme", "sphinx_panels"],
+    install_requires=["sphinx_rtd_theme", "sphinx_design"],
 )
diff --git a/docs/source/AdministratorGuide/index.rst b/docs/source/AdministratorGuide/index.rst
@@ -1,3 +1,4 @@
+.. _administrator_guide:
 ===================
 Administrator Guide
 ===================

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -104,7 +104,7 @@
     "sphinx.ext.graphviz",
     "recommonmark",
     "sphinx_rtd_theme",
-    "sphinx_panels",
+    "sphinx_design",
 ]
 
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -34,43 +34,63 @@ An alternative description of the DIRAC system can be found in this `presentatio
 Documentation
 =============
 
-.. panels::
-  :card: shadow + text-center
-  :img-top-cls: p-5
-
-  :img-top: _static/dirac_user.png
-  .. link-button:: UserGuide/index
-      :type: ref
-      :text: User Guide
-      :classes: btn-link stretched-link font-weight-bold
-
-  including client installation
-
-  ---
-  :img-top: _static/dirac_dev.png
-  .. link-button:: DeveloperGuide/index
-      :type: ref
-      :text: Developer Guide
-      :classes: btn-link stretched-link font-weight-bold
-
-  adding new functionality to DIRAC
-
-  ---
-  :img-top: _static/dirac_admin.png
-  .. link-button:: AdministratorGuide/index
-      :type: ref
-      :text: Administrator Guide
-      :classes: btn-link stretched-link font-weight-bold
-
-  services administration, server installation
-
-  ---
-  :img-top: _static/dirac_code.png
-  .. link-button:: CodeDocumentation/index
-      :type: ref
-      :text: Code Documentation
-      :classes: btn-link stretched-link font-weight-bold
-
-  code reference
+.. grid:: 2
+   :padding: 3
+
+   .. grid-item-card::
+      :shadow: sm
+      :text-align: center
+      :link-type: ref
+      :class-body: btn-link stretched-link font-weight-bold
+      :class-img-top: p-5
+      :img-top: _static/dirac_user.png
+      :link: user-guide
+      :link-alt: User Guide
+
+      User Guide
+
+      including client installation
+
+   .. grid-item-card::
+      :shadow: sm
+      :text-align: center
+      :link-type: ref
+      :class-body: btn-link stretched-link font-weight-bold
+      :class-img-top: p-5
+      :img-top: _static/dirac_dev.png
+      :link: developer_guide
+      :link-alt: Developer Guide
+
+      Developer Guide
+
+      adding new functionality to DIRAC
+
+
+   .. grid-item-card::
+      :shadow: sm
+      :text-align: center
+      :link-type: ref
+      :class-body: btn-link stretched-link font-weight-bold
+      :class-img-top: p-5
+      :img-top: _static/dirac_admin.png
+      :link: administrator_guide
+      :link-alt: Administrator Guide
+
+      Administrator Guide
+
+      services administration, server installation
+
+
+   .. grid-item-card::
+      :shadow: sm
+      :text-align: center
+      :link-type: ref
+      :class-body: btn-link stretched-link font-weight-bold
+      :class-img-top: p-5
+      :img-top: _static/dirac_code.png
+      :link: code_documentation
+      :link-alt: Code Reference
+
+      code reference
 
 :ref:`genindex`