Automatic list with overviews of inlcuded area definitions for the documentation

.gitignore

@@ -75,3 +75,4 @@ doc/source/_build/*
 satpy/version.py
 doc/source/api/*.rst
 doc/source/reader_table.rst
+doc/source/area_def_list.rst

doc/source/conf.py

@@ -26,8 +26,11 @@
 sys.path.append(os.path.abspath('../../'))
 sys.path.append(os.path.abspath(os.path.dirname(__file__)))
 
+from pyresample.area_config import generate_area_def_rst_list # noqa: E402
 from reader_table import generate_reader_table # noqa: E402
 
+from satpy.resample import get_area_file # noqa: E402
+
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
@@ -80,6 +83,10 @@ def __getattr__(cls, name):
 with open("reader_table.rst", mode="w") as f:
  f.write(generate_reader_table())
 
+area_file = get_area_file()[0]
+with open("area_def_list.rst", mode="w") as f:
+ f.write(generate_area_def_rst_list(area_file))
+
 # -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions

satpy/resample.py

@@ -135,7 +135,12 @@
 
 For examples of area definitions, see the file ``etc/areas.yaml`` that is
 included with Satpy and where all the area definitions shipped with Satpy are
-defined.
+defined. The section below gives an overview of these area definitions.
+
+Area definitions included in Satpy
+----------------------------------
+
+.. include:: area_def_list.rst
 
 """
 import hashlib