Merge pull request #221 from scipp/update-docs-frontpage

Add deprecation message and links to other projects on front page

Author: nvaytet

docs/conf.py

@@ -83,6 +83,7 @@ def add_buttons(
     'sphinx.ext.napoleon',
     'sphinx_autodoc_typehints',
     'sphinx_copybutton',
+    'sphinx_design',
     'nbsphinx',
 ]
 

docs/index.rst

@@ -17,6 +17,62 @@
       </br></br>
    </div>
 
+
+.. attention::
+
+   The ``ess`` python package is being split-up into technique and instrument specific packages,
+   and should be considered deprecated.
+   The documentation here is kept for historical reasons.
+   **Below, you will find links to the new packages.**
+
+
+.. grid:: 2
+
+    .. grid-item-card::  ESSdiffraction
+        :link: https://scipp.github.io/essdiffraction/
+
+        Diffraction data reduction
+
+    .. grid-item-card::  ESSnmx
+        :link: https://scipp.github.io/essnmx/
+
+        Data reduction for the NMX instrument
+
+.. grid:: 2
+
+    .. grid-item-card::  ESSpolarization
+        :link: https://scipp.github.io/esspolarization/
+
+        Polarization data reduction
+
+    .. grid-item-card::  ESSreflectometry
+        :link: https://scipp.github.io/essreflectometry/
+
+        Reflectometry data reduction
+
+.. grid:: 2
+
+    .. grid-item-card::  ESSsans
+        :link: https://scipp.github.io/esssans/
+
+        SANS data reduction
+
+    .. grid-item-card::  ESSspectroscopy
+        :link: https://scipp.github.io/essspectroscopy/
+
+        Spectroscopy data reduction
+
+.. grid:: 2
+
+    .. grid-item-card::  ESSreduce
+        :link: https://scipp.github.io/essreduce/
+
+        Common tools for ESS data reduction
+
+.. raw:: html
+
+   <br><br><br><br>
+
 `European Spallation Source`_ (ESS) toolkit for neutron scattering data reduction powered by `scipp`_ and `scippneutron`_.
 Provides ESS facility and instrument bespoke tools.
 The ``ess`` module is part of the software stack for data reduction:

environment.yml

@@ -32,6 +32,7 @@ dependencies:
   - sphinx=4.5.0
   - sphinx-book-theme=0.3.3
   - sphinx-copybutton=0.5.2
+  - sphinx-design==0.4.1
   - pip:
     - orsopy==1.0.1
     - sphinx-autodoc-typehints==1.18.3