more docs

USGS-CMG · Mar 27, 2024 · 49b10a3 · 49b10a3
1 parent 2b108a8
commit 49b10a3
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/doc/conf.py b/doc/conf.py
@@ -43,6 +43,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
     "sphinxarg.ext",
     "sphinx.ext.napoleon",
     "sphinx_rtd_theme",

diff --git a/doc/index.rst b/doc/index.rst
@@ -58,6 +58,7 @@ We have plans to support:
    wxt
    eofe
    lisst
+   tcm
    indexvel
    turnaround
    code

diff --git a/doc/waves.rst b/doc/waves.rst
@@ -7,4 +7,4 @@ Waves can be computed both with fixed frequency cutoffs, as well as dynamic cuto
 
 Spectra tails beyond the cutoff frequency are applied following `Jones & Monismith (2007) <https://doi.org/10.4319/lom.2007.5.317>`_.
 
-For more information, see the code in `stglib/core/waves.py`
+For more information, see the code in ``stglib/core/waves.py``.
-Original file line number
+Diff line change
@@ Expand Up / @@ -58,6 +58,7 @@ We have plans to support: @@
        wxt
        eofe
        lisst
+       tcm
        indexvel
        turnaround
        code
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,4 +7,4 @@ Waves can be computed both with fixed frequency cutoffs, as well as dynamic cuto

		Spectra tails beyond the cutoff frequency are applied following `Jones & Monismith (2007) <https://doi.org/10.4319/lom.2007.5.317>`_.

		For more information, see the code in `stglib/core/waves.py`
		For more information, see the code in ``stglib/core/waves.py``.