Skip to content

Commit 5dcb5fb

Browse files
committed
DOC: add pad to the API documentation
DOC: enable intersphinx extension to allow linking to numpy docs
1 parent 86a6213 commit 5dcb5fb

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

doc/source/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
extensions = ['sphinx.ext.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.todo',
3737
'sphinx.ext.extlinks', 'sphinx.ext.mathjax',
3838
'sphinx.ext.autosummary', 'numpydoc',
39+
'sphinx.ext.intersphinx',
3940
'matplotlib.sphinxext.plot_directive']
4041

4142
# Add any paths that contain templates here, relative to this directory.
@@ -224,3 +225,9 @@
224225
plot_formats = [('png', 96), 'pdf']
225226
plot_html_show_formats = False
226227
plot_html_show_source_link = False
228+
229+
# -- Options for intersphinx extension ---------------------------------------
230+
231+
# Intersphinx to get Numpy and other targets
232+
intersphinx_mapping = {
233+
'numpy': ('https://docs.scipy.org/doc/numpy/', None)}

doc/source/ref/signal-extension-modes.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,15 @@ periodization per N/A
136136
antisymmetric asym, asymh N/A
137137
antireflect asymw reflect, reflect_type='odd'
138138
================== ============= ===========================
139+
140+
Padding using PyWavelets Signal Extension Modes - ``pad``
141+
---------------------------------------------------------
142+
143+
.. autofunction:: pad
144+
145+
Pywavelets provides a function, :func:`pad`, that operate like
146+
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
147+
discussed above. For efficiency, the DWT routines in PyWavelets do not
148+
expclitly create padded signals using this function. It can be used to manually
149+
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
150+
:func:`swt` that do not currently support all of these signal extension modes.

0 commit comments

Comments
 (0)