diff --git a/docs/code_ref/fermi.rst b/docs/code_ref/fermi.rst index f9e0a728..59894c37 100644 --- a/docs/code_ref/fermi.rst +++ b/docs/code_ref/fermi.rst @@ -1 +1,5 @@ +===== +Fermi +===== + .. automodapi:: sunkit_instruments.fermi diff --git a/docs/code_ref/goes_xrs.rst b/docs/code_ref/goes_xrs.rst index 1cc7a0c3..d9cad596 100644 --- a/docs/code_ref/goes_xrs.rst +++ b/docs/code_ref/goes_xrs.rst @@ -1 +1,4 @@ +======== +GOES XRS +======== .. automodapi:: sunkit_instruments.goes_xrs diff --git a/docs/code_ref/index.rst b/docs/code_ref/index.rst index 51cbaa17..7c57362b 100644 --- a/docs/code_ref/index.rst +++ b/docs/code_ref/index.rst @@ -7,7 +7,6 @@ API Reference .. toctree:: :maxdepth: 2 - sunkit_instruments fermi goes_xrs iris diff --git a/docs/code_ref/iris.rst b/docs/code_ref/iris.rst index db0735a6..43068bd3 100644 --- a/docs/code_ref/iris.rst +++ b/docs/code_ref/iris.rst @@ -1 +1,5 @@ +==== +IRIS +==== + .. automodapi:: sunkit_instruments.iris diff --git a/docs/code_ref/lyra.rst b/docs/code_ref/lyra.rst index 7152317f..8e5c19ed 100644 --- a/docs/code_ref/lyra.rst +++ b/docs/code_ref/lyra.rst @@ -1 +1,5 @@ +==== +LYRA +==== + .. automodapi:: sunkit_instruments.lyra diff --git a/docs/code_ref/rhessi.rst b/docs/code_ref/rhessi.rst index 3ba1db6c..719b254c 100644 --- a/docs/code_ref/rhessi.rst +++ b/docs/code_ref/rhessi.rst @@ -1 +1,5 @@ +====== +RHESSI +====== + .. automodapi:: sunkit_instruments.rhessi diff --git a/docs/code_ref/sunkit_instruments.rst b/docs/code_ref/sunkit_instruments.rst deleted file mode 100644 index f1ef25dc..00000000 --- a/docs/code_ref/sunkit_instruments.rst +++ /dev/null @@ -1 +0,0 @@ -.. automodapi:: sunkit_instruments diff --git a/docs/code_ref/suvi.rst b/docs/code_ref/suvi.rst index 600b4f65..3b478b6f 100644 --- a/docs/code_ref/suvi.rst +++ b/docs/code_ref/suvi.rst @@ -1,4 +1,8 @@ -This package provides helper routines for the SUVI (Solar UltraViolet Imager) instrument on the GOES-R series of satellites. +==== +SUVI +==== + +Helper routines for the Solar UltraViolet Imager (SUVI) instrument on the GOES-R series of satellites. .. note:: diff --git a/docs/index.rst b/docs/index.rst index 7ec3d837..ab9dc495 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,10 @@ -================================ -sunkit-instruments Documentation -================================ +================== +sunkit-instruments +================== -This is the documentation for sunkit-instruments. +A package for instrument-specific data structures and processing in the SunPy ecosystem. + +``sunkit-instruments`` is organised into sub-modules for each instrument: .. toctree:: :maxdepth: 2 @@ -10,3 +12,10 @@ This is the documentation for sunkit-instruments. code_ref/index generated/gallery/index whatsnew/index + + +Note that the code in this package is **not** maintained by or neccesarily contributed to by instrument teams. +Some instruments have individual packages for analysis in Python, including: + +- `aiapy `__ +- `eispac `__