add deprecation message and links to other projects on front page

scipp · Mar 20, 2024 · 3ae1a36 · 3ae1a36
1 parent 5372ef6
commit 3ae1a36
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -83,6 +83,7 @@ def add_buttons(
     'sphinx.ext.napoleon',
     'sphinx_autodoc_typehints',
     'sphinx_copybutton',
+    'sphinx_design',
     'nbsphinx',
 ]
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -17,6 +17,28 @@
       </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.
+
+
+.. grid:: 2
+
+    .. grid-item-card::  ESSsans
+        :link: https://scipp.github.io/esssans/
+
+        A
+
+    .. grid-item-card::  ESSdiffraction
+        :link: https://scipp.github.io/essdiffraction/
+
+        B
+
+
+
 `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:

diff --git a/environment.yml b/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.5.0
   - pip:
     - orsopy==1.0.1
     - sphinx-autodoc-typehints==1.18.3