Add hrit readers info to the main documentation

pytroll · Nov 22, 2018 · d03dd73 · d03dd73
1 parent a6a0962
commit d03dd73
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 7 deletions.
diff --git a/doc/source/readers.rst b/doc/source/readers.rst
@@ -113,3 +113,19 @@ Adding a Reader to SatPy
 ========================
 
 Coming soon...
+
+Implemented readers
+===================
+
+xRIT-based readers
+------------------
+
+.. automodule:: satpy.readers.hrit_base
+
+.. automodule:: satpy.readers.hrit_msg
+
+.. automodule:: satpy.readers.hrit_jma
+
+.. automodule:: satpy.readers.hrit_goes
+
+.. automodule:: satpy.readers.hrit_electrol
diff --git a/satpy/readers/hrit_base.py b/satpy/readers/hrit_base.py
@@ -21,6 +21,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """HRIT/LRIT format reader
+***************************
 
 This module is the base module for all HRIT-based formats. Here, you will find
 the common building blocks for hrit reading.

diff --git a/satpy/readers/hrit_electrol.py b/satpy/readers/hrit_electrol.py
@@ -22,7 +22,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""HRIT format reader.
+"""HRIT format reader
+**********************
 
 References:
     ELECTRO-L GROUND SEGMENT MSU-GS INSTRUMENT,

diff --git a/satpy/readers/hrit_goes.py b/satpy/readers/hrit_goes.py
@@ -21,7 +21,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""GOES HRIT format reader.
+"""GOES HRIT format reader
+****************************
 
 References:
       LRIT/HRIT Mission Specific Implementation, February 2012

diff --git a/satpy/readers/hrit_jma.py b/satpy/readers/hrit_jma.py
@@ -20,7 +20,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""HRIT format reader for JMA data.
+"""HRIT format reader for JMA data
+************************************
 
 References:
     JMA HRIT - Mission Specific Implementation

diff --git a/satpy/readers/hrit_msg.py b/satpy/readers/hrit_msg.py
@@ -22,14 +22,12 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""SEVIRI HRIT format reader.
+"""SEVIRI HRIT format reader
+******************************
 
 References:
     MSG Level 1.5 Image Data FormatDescription
 
-TODO:
-- HRV navigation
-
 """
 
 import logging