Doc: Add Grid to Front page

hyperspy · Oct 21, 2024 · a4cd1e5 · a4cd1e5
1 parent 51f0b70
commit a4cd1e5
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 32 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -39,6 +39,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinxcontrib.towncrier",
+    "sphinx_design",
 ]
 
 intersphinx_mapping = {

diff --git a/doc/index.rst b/doc/index.rst
@@ -7,6 +7,66 @@
 RosettaSciIO documentation
 ##########################
 
+
+.. grid:: 2 3 3 3
+  :gutter: 2
+
+  .. grid-item-card::
+    :link: user_guide/installing
+    :link-type: doc
+
+    :octicon:`rocket;2em;sd-text-info` Getting Started
+    ^^^
+
+    New to rosettasciio or Python? The getting started guide provides an
+    introduction on basic usage of rosettasciio and how to install it.
+
+  .. grid-item-card::
+    :link: supported_formats/index
+    :link-type: doc
+
+    :octicon:`checklist;2em;sd-text-info` Supported Formats
+    ^^^
+
+    This provides a nice overview of the different files that can be read and written by rosettasciio.
+
+  .. grid-item-card::
+    :link: interoperability
+    :link-type: doc
+
+    :octicon:`arrow-switch;2em;sd-text-info` Interoperability
+    ^^^
+
+    Documentation describing how to use rosettasciio with other libraries than HyperSpy.
+
+  .. grid-item-card::
+    :link: file_specification/index
+    :link-type: doc
+
+    :octicon:`checklist;2em;sd-text-info` File Specifications
+    ^^^
+
+    Links to File Specifications for the different file formats supported by rosettasciio.
+
+  .. grid-item-card::
+    :link: api/index
+    :link-type: doc
+
+    :octicon:`book;2em;sd-text-info` API Reference
+    ^^^
+
+    Documentation of the Application Programming Interface (API),
+
+  .. grid-item-card::
+    :link: contributing
+    :link-type: doc
+
+    :octicon:`code-square;2em;sd-text-info` Contributing
+    ^^^
+
+    Information on how to contribute to the development of rosettasciio.
+
+
 The **Rosetta Scientific Input Output library** aims at providing easy reading and
 writing capabilities in Python for a wide range of
 :ref:`scientific data formats <supported-formats>`. Thus

diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst
@@ -3,38 +3,8 @@
 User Guide
 ==========
 
-
-.. grid:: 1 3 3 3
-  :gutter: 2
-
-  .. grid-item-card::
-    :link: user_guide/installing
-    :link-type: doc
-
-    :octicon:`rocket;2em;sd-text-info` Getting Started
-    ^^^
-
-    New to rosettasciio or Python? The getting started guide provides an
-    introduction on basic usage of rosettasciio and how to install it.
-
-  .. grid-item-card::
-    :link: supported_formats/index
-    :link-type: doc
-
-    :octicon:`book;2em;sd-text-info` User Guide
-    ^^^
-
-    This provides a nice overview of the different files that can be read and written by rosettasciio.
-
-  .. grid-item-card::
-    :link: interoperability
-    :link-type: doc
-
-    :octicon:`code-square;2em;sd-text-info` Reference
-    ^^^
-
-    Documentation describing how to use rosettasciio with other libraries than HyperSpy.
-
+Welcome to the RosettaSciIO user guide. This guide provides in-depth information on key concepts of RosettaSciIO
+and how to use it along with background information and explanations.
 
 .. toctree::
    :maxdepth: 2

diff --git a/pyproject.toml b/pyproject.toml
@@ -118,6 +118,7 @@ doc = [
   "sphinxcontrib-towncrier",
   # unpin when sphinxcontrib-towncrier supports towncrier >=24
   "towncrier<24",
+  "sphinx_design",
 ]
 all = [
   "rosettasciio[blockfile]",