DOC: use autoapi syntax

pysat · Apr 13, 2021 · 239205d · 239205d
1 parent ace005e
commit 239205d
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 20 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -41,8 +41,10 @@
               'autoapi.extension',
               'numpydoc',
               'm2r2']
-# Tell autoapi where the package is
+
+# Configure autoapi
 autoapi_dirs = ['../pysatNASA']
+autoapi_add_toctree_entry = False
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']

diff --git a/docs/supported_constellations.rst b/docs/supported_constellations.rst
@@ -6,13 +6,13 @@ DE2
 
 The Dynamics Explorer 2 spacecraft
 
-.. automodule:: pysatNASA.constellations.de2
+.. autoapimodule:: pysatNASA.constellations.de2
    :members:
 
 ICON
 ----
 
 The Ionosphere CONnection explorer spacecraft
 
-.. automodule:: pysatNASA.constellations.icon
+.. autoapimodule:: pysatNASA.constellations.icon
    :members:
diff --git a/docs/supported_instruments.rst b/docs/supported_instruments.rst
@@ -4,102 +4,102 @@ Supported Instruments
 C/NOFS IVM
 ----------
 
-.. automodule:: pysatNASA.instruments.cnofs_ivm
+.. autoapimodule:: pysatNASA.instruments.cnofs_ivm
    :members:
 
 C/NOFS PLP
 ----------
 
-.. automodule:: pysatNASA.instruments.cnofs_plp
+.. autoapimodule:: pysatNASA.instruments.cnofs_plp
    :members:
 
 C/NOFS VEFI
 -----------
 
-.. automodule:: pysatNASA.instruments.cnofs_vefi
+.. autoapimodule:: pysatNASA.instruments.cnofs_vefi
    :members:
 
 DE2 LANG
 -----------
 
-.. automodule:: pysatNASA.instruments.de2_lang
+.. autoapimodule:: pysatNASA.instruments.de2_lang
    :members:
 
 DE2 NACS
 -----------
 
-.. automodule:: pysatNASA.instruments.de2_nacs
+.. autoapimodule:: pysatNASA.instruments.de2_nacs
    :members:
 
 DE2 RPA
 -----------
 
-.. automodule:: pysatNASA.instruments.de2_rpa
+.. autoapimodule:: pysatNASA.instruments.de2_rpa
    :members:
 
 DE2 WATS
 -----------
 
-.. automodule:: pysatNASA.instruments.de2_wats
+.. autoapimodule:: pysatNASA.instruments.de2_wats
    :members:
 
 FORMOSAT-1 IVM
 --------------
 
-.. automodule:: pysatNASA.instruments.formosat1_ivm
+.. autoapimodule:: pysatNASA.instruments.formosat1_ivm
   :members:
 
 ICON EUV
 --------
 
-.. automodule:: pysatNASA.instruments.icon_euv
+.. autoapimodule:: pysatNASA.instruments.icon_euv
    :members:
 
 ICON FUV
 --------
 
-.. automodule:: pysatNASA.instruments.icon_fuv
+.. autoapimodule:: pysatNASA.instruments.icon_fuv
    :members:
 
 ICON IVM
 --------
 
-.. automodule:: pysatNASA.instruments.icon_ivm
+.. autoapimodule:: pysatNASA.instruments.icon_ivm
    :members:
 
 ICON MIGHTI
 -----------
 
-.. automodule:: pysatNASA.instruments.icon_mighti
+.. autoapimodule:: pysatNASA.instruments.icon_mighti
    :members:
 
 ISS-FPMU
 --------
 
-.. automodule:: pysatNASA.instruments.iss_fpmu
+.. autoapimodule:: pysatNASA.instruments.iss_fpmu
    :members:
 
 OMNI_HRO
 --------
 
-.. automodule:: pysatNASA.instruments.omni_hro
+.. autoapimodule:: pysatNASA.instruments.omni_hro
    :members: , calculate_clock_angle, calculate_imf_steadiness, time_shift_to_magnetic_poles
 
 
 SES14 GOLD
 ----------
 
-.. automodule:: pysatNASA.instruments.ses14_gold
+.. autoapimodule:: pysatNASA.instruments.ses14_gold
    :members:
 
 TIMED/SABER
 -----------
 
-.. automodule:: pysatNASA.instruments.timed_saber
+.. autoapimodule:: pysatNASA.instruments.timed_saber
    :members:
 
 TIMED/SEE
 ---------
 
-.. automodule:: pysatNASA.instruments.timed_see
+.. autoapimodule:: pysatNASA.instruments.timed_see
    :members: