Fixes for standard automodule

docs/archived_topics.rst

@@ -11,7 +11,7 @@ fetching and using telemetry data into a single function call.  This includes:
   either full-resolution, 5-minute, or daily data.
 - Filter out bad or missing data.
 - Interpolate (resample) all MSID values to a common uniformly-spaced time sequence.
-- Remove or select time intervals corresponding to specified |kadi| event types.
+- Remove or select time intervals corresponding to specified `kadi` event types.
 - Change the time format from CXC seconds (seconds since 1998.0) to something more
   convenient like GRETA time.
 - Write the MSID telemetry data to a zip file.
@@ -90,7 +90,7 @@ remove_events  Remove kadi events expression (default=None)
 select_events  Select kadi events expression (default=None)
 ============== ======================================================
 
-These arguments allow you to select or remove intervals in the data using the |kadi|
+These arguments allow you to select or remove intervals in the data using the `kadi`
 event definitions. For instance we can select times of stable NPM dwells during
 radiation zones::
 
@@ -101,7 +101,7 @@ radiation zones::
 The order of processing is to first remove event intervals, then select event intervals.
 
 The expression for ``remove_events`` or ``select_events`` can be any logical expression
-involving |kadi| event query names.  The
+involving `kadi` event query names.  The
 following string would be valid: ``'dsn_comms | (dwells[pad=-300] & ~eclipses)'``, and for
 ``select_events`` this would imply selecting telemetry which is either during a DSN pass
 or (within a NPM dwell and not during an eclipse).  The ``[pad=-300]`` qualifier means
@@ -167,7 +167,7 @@ fetching and using telemetry data:
   either full-resolution, 5-minute, or daily data.
 - Filter out bad or missing data.
 - Interpolate (resample) all MSID values to a common uniformly-spaced time sequence.
-- Remove or select time intervals corresponding to specified |kadi| event types.
+- Remove or select time intervals corresponding to specified `kadi` event types.
 - Change the time format from CXC seconds (seconds since 1998.0) to something more
   convenient like GRETA time.
 - Write the MSID telemetry data to a zip file.
@@ -382,7 +382,7 @@ Argument         Description
 --select_events  Select kadi events expression (default=None)
 ================ ======================================================
 
-These arguments allow you to select or remove intervals in the data using the |kadi|
+These arguments allow you to select or remove intervals in the data using the `kadi`
 event definitions. For instance we can select times of stable NPM dwells during
 radiation zones::
 
@@ -396,7 +396,7 @@ by the shell.
 The order of processing is to first remove event intervals, then select event intervals.
 
 The expression for ``--remove_events`` or ``--select_events`` can be any logical
-expression involving |kadi| event query names.  The following string would be valid:
+expression involving `kadi` event query names.  The following string would be valid:
 ``'dsn_comms | (dwells[pad=-300] & ~eclipses)'``, and for ``select_events`` this would
 imply selecting telemetry which is either during a DSN pass or (within a NPM dwell and
 not during an eclipse).  The ``[pad=-300]`` qualifier means that a buffer of 300 seconds

docs/conf.py

@@ -24,8 +24,6 @@
 # Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-#     "sphinx.ext.autodoc",
-#     "sphinx.ext.autosummary",
     "sphinx.ext.mathjax",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
@@ -101,6 +99,7 @@
 }
 
 automodapi_inheritance_diagram = False
+automodapi_toctreedirnm = "_api"
 # autosummary_generate = True
 # autosummary_imported_members = False
 

docs/fetch_tutorial.rst

@@ -222,7 +222,7 @@ Using Kadi
 ^^^^^^^^^^^
 
 Frequently one can handle this with the :func:`~cheta.fetch.MSID.remove_intervals`
-:func:`~cheta.fetch.MSID.select_intervals` methods in conjunction with the |kadi| event
+:func:`~cheta.fetch.MSID.select_intervals` methods in conjunction with the `kadi` event
 intervals mechanism.
 
 As a simple example, the following code fetches the pitch component of the spacecraft
@@ -266,7 +266,7 @@ after the end of each maneuver.
 Using logical intervals
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-For cases where the intervals to be filtered cannot be expressed as |kadi| events,
+For cases where the intervals to be filtered cannot be expressed as `kadi` events,
 the approach is to use the :func:`~cheta.utils.logical_intervals` function
 located in the ``cheta.utils`` module.  This function creates an intervals
 table where each row represents a desired interval and includes a ``datestart`` and

docs/references.rst

@@ -2,7 +2,6 @@
 .. |fetch_MSIDset| replace:: :func:`~cheta.fetch.MSIDset`
 .. |fetch_MSIDset_interpolate| replace:: :func:`~cheta.fetch.MSIDset.interpolate`
 .. |get_telem| replace:: :func:`~cheta.fetch.get_telem`
-.. |kadi| replace:: `kadi <https://sot.github.io/kadi/>`_
 
 .. _`Main`: index.html
 .. _`overview`: index.html
@@ -18,3 +17,5 @@
 .. _HEAsoft: http://heasarc.gsfc.nasa.gov/lheasoft/
 .. _CIAO: http://cxc.harvard.edu/ciao/
 .. _SAS: http://xmm.vilspa.esa.es/sas/
+.. _kadi: https://sot.github.io/kadi/
+