From 1c128a830382e52f37e8f34a92fefdd64204554d Mon Sep 17 00:00:00 2001 From: trichter Date: Tue, 21 May 2024 22:27:53 +0200 Subject: [PATCH] update sphinx configuration --- .readthedocs.yaml | 1 + docs/conf.py | 10 ++++++++-- docs/index.rst | 2 +- rf/deconvolve.py | 2 +- 4 files changed, 11 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 81b0cd8..4ed790a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,3 +1,4 @@ +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details version: 2 build: os: ubuntu-22.04 diff --git a/docs/conf.py b/docs/conf.py index b6c40ac..0126f36 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -88,7 +88,13 @@ def get_all_param_type_declarations(): 'sphinx.ext.viewcode', 'alabaster'] -autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance'] + +autodoc_default_options = { + 'members': True, + 'undoc-members': True, + 'show-inheritance': True, +} + default_role = 'py:obj' # Add any paths that contain templates here, relative to this directory. @@ -222,6 +228,6 @@ def get_all_param_type_declarations(): # Configuration for intersphinx -intersphinx_mapping = {'obspy': ('http://docs.obspy.org/', None), +intersphinx_mapping = {'obspy': ('https://docs.obspy.org/', None), #'python': ('https://docs.python.org/2.7/', None) } diff --git a/docs/index.rst b/docs/index.rst index 8c6a9c0..af4463a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -49,4 +49,4 @@ Template Configuration File =========================== .. literalinclude:: ../rf/example/conf.json - :linenos: \ No newline at end of file + :linenos: diff --git a/rf/deconvolve.py b/rf/deconvolve.py index 3502a4f..ecf5bfe 100644 --- a/rf/deconvolve.py +++ b/rf/deconvolve.py @@ -459,7 +459,7 @@ def deconv_iterative(rsp, src, sampling_rate, tshift=10, gauss=0.5, itmax=400, spike drops below this threshold :param mute_shift: Mutes all samples at beginning of trace (lenght given by time shift). - For `len(src)==len(rsp)` this mutes all samples before the onset. + For ``len(src)==len(rsp)`` this mutes all samples before the onset. :param normalize: normalize all results so that the maximum of the trace with the supplied index is 1. Set normalize to None for no normalization.