Skip to content

Commit

Permalink
update sphinx configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
trichter committed May 21, 2024
1 parent 30730aa commit 1c128a8
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 4 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
Expand Down
10 changes: 8 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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)
}
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ Template Configuration File
===========================

.. literalinclude:: ../rf/example/conf.json
:linenos:
:linenos:
2 changes: 1 addition & 1 deletion rf/deconvolve.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 1c128a8

Please sign in to comment.