Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
4 changes: 4 additions & 0 deletions docs/code_ref/fermi.rst
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
=====
Fermi
=====

.. automodapi:: sunkit_instruments.fermi
3 changes: 3 additions & 0 deletions docs/code_ref/goes_xrs.rst
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
========
GOES XRS
========
.. automodapi:: sunkit_instruments.goes_xrs
1 change: 0 additions & 1 deletion docs/code_ref/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ API Reference
.. toctree::
:maxdepth: 2

sunkit_instruments
fermi
goes_xrs
iris
Expand Down
4 changes: 4 additions & 0 deletions docs/code_ref/iris.rst
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
====
IRIS
====

.. automodapi:: sunkit_instruments.iris
4 changes: 4 additions & 0 deletions docs/code_ref/lyra.rst
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
====
LYRA
====

.. automodapi:: sunkit_instruments.lyra
4 changes: 4 additions & 0 deletions docs/code_ref/rhessi.rst
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
======
RHESSI
======

.. automodapi:: sunkit_instruments.rhessi
1 change: 0 additions & 1 deletion docs/code_ref/sunkit_instruments.rst

This file was deleted.

6 changes: 5 additions & 1 deletion docs/code_ref/suvi.rst
Original file line number Diff line number Diff line change
@@ -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::

Expand Down
17 changes: 13 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
================================
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

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 <https://aiapy.readthedocs.io/en/stable/>`__
- `eispac <https://eispac.readthedocs.io/en/latest/>`__