Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation message and links to other projects on front page #221

Merged
merged 4 commits into from
Mar 21, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ def add_buttons(
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints',
'sphinx_copybutton',
'sphinx_design',
'nbsphinx',
]

Expand Down
49 changes: 49 additions & 0 deletions docs/index.rst
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link to ESSreduce as well?

Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,55 @@
</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

.. 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:
Expand Down
1 change: 1 addition & 0 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading