[skip ci] beta test sphinx-design

sunpy · Jun 19, 2022 · a519ad9 · a519ad9
1 parent 7ad2d54
commit a519ad9
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 74 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -113,7 +113,7 @@
     'sunpy.util.sphinx.doctest',
     'sunpy.util.sphinx.generate',
     "sphinxext.opengraph",
-    'sphinx_panels',
+    'sphinx_design',
 ]
 
 # Set automodapi to generate files inside the generated directory

diff --git a/docs/dev_guide/index.rst b/docs/dev_guide/index.rst
@@ -12,54 +12,52 @@ Developer's Guide
 
 This section contains the various guidelines to be followed by anyone working on sunpy.
 
-.. panels::
-
-    Getting started
-    ^^^^^^^^^^^^^^^
-    .. toctree::
-      :maxdepth: 3
-
-      contents/newcomers
-
-    ---
-
-    Conventions
-    ^^^^^^^^^^^
-    .. toctree::
-      :maxdepth: 1
-
-      contents/code_standards
-      contents/tests
-      contents/documentation
-      contents/example_gallery
-      contents/pr_review_procedure
-      contents/units_quantities
-
-    ---
-
-    Repo management
-    ^^^^^^^^^^^^^^^
-    .. toctree::
-      :maxdepth: 1
-
-      contents/maintainer_workflow
-      contents/dependencies
-      contents/ci_jobs
-      contents/funding
-
-    ---
-
-    Extending sunpy
-    ^^^^^^^^^^^^^^^
-    .. toctree::
-      :maxdepth: 1
-
-      contents/public_api
-      contents/extending_fido
-      contents/logger
-      contents/new_objects
-      contents/remote_data
-      contents/map_rotate_custom
+.. grid:: 2
+
+    .. grid-item-card:: Getting started
+        :class-card: card
+
+        .. toctree::
+            :maxdepth: 3
+
+            contents/newcomers
+
+    .. grid-item-card:: Conventions
+        :class-card: card
+
+        .. toctree::
+            :maxdepth: 1
+
+            contents/code_standards
+            contents/tests
+            contents/documentation
+            contents/example_gallery
+            contents/pr_review_procedure
+            contents/units_quantities
+
+    .. grid-item-card:: Repo management
+        :class-card: card
+
+        .. toctree::
+            :maxdepth: 1
+
+            contents/maintainer_workflow
+            contents/dependencies
+            contents/ci_jobs
+            contents/funding
+
+    .. grid-item-card:: Extending sunpy
+        :class-card: card
+
+        .. toctree::
+            :maxdepth: 1
+
+            contents/public_api
+            contents/extending_fido
+            contents/logger
+            contents/new_objects
+            contents/remote_data
+            contents/map_rotate_custom
 
 {%else%}
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,27 +5,27 @@ sunpy core Documentation
 The sunpy core package is a community-developed, free and open-source solar
 data analysis environment for Python.
 
-.. panels::
-
-    Getting started
-    ^^^^^^^^^^^^^^^
-    .. toctree::
-      :maxdepth: 1
-
-      installation
-      guide/index
-      generated/gallery/index
-      code_ref/index
-      whatsnew/index
-
-    ---
-
-    Other info
-    ^^^^^^^^^^
-    .. toctree::
-      :maxdepth: 1
-
-      about
-      code_ref/known_issues
-      code_ref/stability
-      dev_guide/index
+.. grid:: 2
+
+    .. grid-item-card:: Getting started
+        :class-card: card
+
+        .. toctree::
+            :maxdepth: 1
+
+            installation
+            guide/index
+            generated/gallery/index
+            code_ref/index
+            whatsnew/index
+
+    .. grid-item-card:: Other info
+        :class-card: card
+
+        .. toctree::
+            :maxdepth: 1
+
+            about
+            code_ref/known_issues
+            code_ref/stability
+            dev_guide/index
diff --git a/setup.cfg b/setup.cfg
@@ -97,7 +97,7 @@ docs =
   sphinx-automodapi
   sphinx-changelog>=1.1.1 # First to support towncrier 21.3
   sphinx-gallery>=0.9.0 # First to include the defer figures functionality
-  sphinx-panels
+  sphinx-design
   sphinxext-opengraph
   sunpy-sphinx-theme