DOC: Migrate from sphinx-panels to sphinx-design

The former has been deprecated for the latter.
stefmolin · May 31, 2022 · d9f7c16 · d9f7c16
1 parent 86b777b
commit d9f7c16
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 53 deletions.
diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css
@@ -256,20 +256,6 @@ table.property-table td {
     width: 210px;
 }
 
-/* Two columns for install code blocks */
-div.twocol {
-    padding-left: 0;
-    padding-right: 0;
-    display: flex;
-    gap: 20px;
-}
-
-div.twocol > div {
-    flex-grow: 1;
-    padding: 0;
-    margin: 0;
-}
-
 /* Fix selection of parameter names; remove when fixed in the theme
  * https://github.com/sphinx-doc/sphinx/pull/9763
  */

diff --git a/doc/conf.py b/doc/conf.py
@@ -72,15 +72,13 @@
     'sphinxext.skip_deprecated',
     'sphinxext.redirect_from',
     'sphinx_copybutton',
-    'sphinx_panels',
+    'sphinx_design',
 ]
 
 exclude_patterns = [
     'api/prev_api_changes/api_changes_*/*',
 ]
 
-panels_add_bootstrap_css = False
-
 
 def _check_dependencies():
     names = {

diff --git a/doc/index.rst b/doc/index.rst
@@ -16,17 +16,17 @@ and interactive visualizations in Python.
 Installation
 ************
 
-.. container:: twocol
+.. grid:: 1 1 2 2
 
-    .. container::
+    .. grid-item::
 
         Install using `pip <https://pypi.org/project/matplotlib>`__:
 
         .. code-block:: bash
 
             pip install matplotlib
 
-    .. container::
+    .. grid-item::
 
         Install using `conda <https://docs.continuum.io/anaconda/>`__:
 
@@ -41,46 +41,57 @@ Further details are available in the :doc:`Installation Guide <users/installing/
 Learning resources
 ******************
 
-.. panels::
+.. grid:: 1 1 2 2
 
-    Tutorials
-    ^^^^^^^^^
+    .. grid-item-card::
+        :class-header: sd-bg-light
+        :padding: 2
 
-    - :doc:`Quick-start guide <tutorials/introductory/quick_start>`
-    - :doc:`Plot types <plot_types/index>`
-    - `Introductory tutorials <../tutorials/index.html#introductory>`_
-    - :doc:`External learning resources <users/resources/index>`
+        Tutorials
+        ^^^
 
-    ---
+        - :doc:`Quick-start guide <tutorials/introductory/quick_start>`
+        - :doc:`Plot types <plot_types/index>`
+        - `Introductory tutorials <../tutorials/index.html#introductory>`_
+        - :doc:`External learning resources <users/resources/index>`
 
-    How-tos
-    ^^^^^^^
-    - :doc:`Example gallery <gallery/index>`
-    - :doc:`Matplotlib FAQ <users/faq/index>`
+    .. grid-item-card::
+        :class-header: sd-bg-light
+        :padding: 2
 
-    ---
+        How-tos
+        ^^^
 
-    Understand how Matplotlib works
-    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+        - :doc:`Example gallery <gallery/index>`
+        - :doc:`Matplotlib FAQ <users/faq/index>`
 
-    - The :ref:`users-guide-explain` in the :doc:`Users guide <users/index>`
-    - Many of the :ref:`Intermediate <tutorials-intermediate>` and
-      :ref:`Advanced <tutorials-advanced>` tutorials
-      have explanatory material
+    .. grid-item-card::
+        :class-header: sd-bg-light
+        :padding: 2
 
-    ---
+        Understand how Matplotlib works
+        ^^^
 
-    Reference
-    ^^^^^^^^^
+        - The :ref:`users-guide-explain` in the :doc:`Users guide
+          <users/index>`
+        - Many of the :ref:`Intermediate <tutorials-intermediate>` and
+          :ref:`Advanced <tutorials-advanced>` tutorials have explanatory
+          material
 
-    - :doc:`API Reference <api/index>`
-    - :doc:`Axes API <api/axes_api>` for most plotting methods
-    - :doc:`Figure API <api/figure_api>` for figure-level methods
-    - Top-level interfaces to create:
+    .. grid-item-card::
+        :class-header: sd-bg-light
+        :padding: 2
 
-      - Figures (`.pyplot.figure`)
-      - Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)
+        Reference
+        ^^^
 
+        - :doc:`API Reference <api/index>`
+        - :doc:`Axes API <api/axes_api>` for most plotting methods
+        - :doc:`Figure API <api/figure_api>` for figure-level methods
+        - Top-level interfaces to create:
+
+          - Figures (`.pyplot.figure`)
+          - Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)
 
 
 ********************

diff --git a/doc/users/getting_started/index.rst b/doc/users/getting_started/index.rst
@@ -4,17 +4,17 @@ Getting started
 Installation quick-start
 ------------------------
 
-.. container:: twocol
+.. grid:: 1 1 2 2
 
-    .. container::
+    .. grid-item::
 
         Install using `pip <https://pypi.org/project/matplotlib>`__:
 
         .. code-block:: bash
 
             pip install matplotlib
 
-    .. container::
+    .. grid-item::
 
         Install using `conda <https://docs.continuum.io/anaconda/>`__:
 

diff --git a/environment.yml b/environment.yml
@@ -33,7 +33,7 @@ dependencies:
   - sphinx>=1.8.1,!=2.0.0
   - sphinx-copybutton
   - sphinx-gallery>=0.10
-  - sphinx-panels
+  - sphinx-design
   - pip
   - pip:
       - mpl-sphinx-theme

diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt
@@ -18,4 +18,4 @@ mpl-sphinx-theme
 sphinxcontrib-svg2pdfconverter>=1.1.0
 sphinx-gallery>=0.10
 sphinx-copybutton
-sphinx-panels
+sphinx-design