Initial steps towards interactive documentation via JupyterLite#728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rgommers merged 11 commits into from
Mar 28, 2024
Merged

Initial steps towards interactive documentation via JupyterLite #728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fac14a9
DOC: ignore unneeded directories and databases
agriyakhetarpal Mar 14, 2024
534833e
DOC: add `jupyterlite-sphinx` to RTD requirements
agriyakhetarpal Mar 14, 2024
ee7df9b
DOC: start to configure JupyterLite
agriyakhetarpal Mar 14, 2024
803ca13
DOC: ship a Pyodide kernel on RTD
agriyakhetarpal Mar 14, 2024
dcb3088
DOC: Reconfigure admonition for Pyodide kernels
agriyakhetarpal Mar 15, 2024
9aaf45b
DOC: Add custom CSS to style "Try" button
agriyakhetarpal Mar 22, 2024
f15c822
DOC: Add a global minimum height for notebooks
agriyakhetarpal Mar 22, 2024
6d1145e
DOC: Move example for `pywt.data.demo_signal()`
agriyakhetarpal Mar 22, 2024
fbb063a
DOC: Update SciPy intersphinx target location
agriyakhetarpal Mar 22, 2024
68a2f41
DOC: `.. sourcecode::` ➡️ `..try_examples::`
agriyakhetarpal Mar 22, 2024
7977ff8
DOC: Add custom `:button_text:` for all examples
agriyakhetarpal Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ __pycache__
*.egg-info
dist
build
_build
.installed.cfg

# Installer logs
Expand All@@ -19,6 +20,11 @@ pip-log.txt
.coverage
.tox

# Sphinx documentation
doc/_build/
doc/build/
.jupyterlite.doit.db

# Editors
.idea
.project
Expand Down
27 changes: 27 additions & 0 deletions doc/source/_static/pywavelets.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
/* Custom CSS rules for the interactive documentation button */

.try_examples_button {
color: white;
background-color: #0054a6;
border: none;
padding: 5px 10px;
border-radius: 10px;
margin-bottom: 5px;
box-shadow: 0 2px 5px rgba(108,108,108,0.2);
font-weight: bold;
font-size: small;
}

.try_examples_button:hover {
background-color: #0066cc;
transform: scale(1.02);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
cursor: pointer;
}

.try_examples_button_container {
display: flex;
justify-content: flex-start;
gap: 10px;
margin-bottom: 20px;
}
25 changes: 23 additions & 2 deletions doc/source/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'jupyterlite_sphinx',
'matplotlib.sphinxext.plot_directive',
'numpydoc',
'sphinx.ext.autodoc',
Expand DownExpand Up@@ -193,6 +194,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# CSS files to include in the build. The file path should be relative to the
# _static directory.
html_css_files = [
"pywavelets.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand DownExpand Up@@ -282,8 +289,22 @@

# -- Options for intersphinx extension ---------------------------------------

# Intersphinx to get Numpy and other targets
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
'numpy': ('https://numpy.org/devdocs', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
'scipy': ('https://docs.scipy.org/doc/scipy/', None),
}

# -- Options for JupyterLite -------------------------------------------------

global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = (
"""These interactive examples with JupyterLite are experimental and
may not always work as expected. The execution of cells containing import
statements can result in high bandwidth usage and may take a long time to
load. They may not be in sync with the latest PyWavelets release.

Shall you encounter any issues, please feel free to report them on the
[PyWavelets issue tracker](https://github.com/PyWavelets/pywt/issues)."""
)
12 changes: 8 additions & 4 deletions doc/source/ref/cwt.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,9 +89,11 @@ Continuous Wavelet Families
A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

wavlist = pywt.wavelist(kind='continuous')
>>> import pywt
>>> wavelist = pywt.wavelist(kind='continuous')

Here is an overview of all available wavelets for ``cwt``. Note, that they can be
customized by passing parameters such as ``center_frequency`` and ``bandwidth_frequency``
Expand DownExpand Up@@ -205,7 +207,8 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
``scale = 1``. This is above the Nyquist rate of 50 Hz, so for this
particular wavelet, one would analyze a signal using ``scales >= 2``.

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import numpy as np
>>> import pywt
Expand DownExpand Up@@ -235,7 +238,8 @@ the input frequency in this function is normalized by 1/dt, or the sampling
frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import numpy as np
>>> import pywt
Expand Down
9 changes: 0 additions & 9 deletions doc/source/ref/other-functions.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,12 +64,3 @@ Each can be loaded via a function of the same name.

.. currentmodule:: pywt.data
.. autofunction:: demo_signal

**Example:**

.. sourcecode:: python

>>> import pywt
>>> camera = pywt.data.camera()
>>> doppler = pywt.data.demo_signal('doppler', 1024)
>>> available_signals = pywt.data.demo_signal('list')
12 changes: 7 additions & 5 deletions doc/source/ref/signal-extension-modes.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,10 @@ computations can be performed with the `periodization`_ mode:
smallest possible number of decomposition coefficients. :ref:`IDWT <ref-idwt>` must be
performed with the same mode.

**Example:**
**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> print(pywt.Modes.modes)
Expand All@@ -104,7 +105,8 @@ signal to an even length prior to using periodic boundary conditions.
Notice that you can use any of the following ways of passing wavelet and mode
parameters:

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand DownExpand Up@@ -142,8 +144,8 @@ Padding using PyWavelets Signal Extension Modes - ``pad``

.. autofunction:: pad

Pywavelets provides a function, :func:`pad`, that operate like
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
Pywavelets provides a function, :func:`pad`, that operates like
:func:`numpy.pad`, but supports the PyWavelets signal extension modes
discussed above. For efficiency, the DWT routines in PyWavelets do not
expclitly create padded signals using this function. It can be used to manually
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
Expand Down
27 changes: 18 additions & 9 deletions doc/source/ref/wavelets.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ Custom discrete wavelets are also supported through the

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> wavelet = pywt.Wavelet('db1')
Expand DownExpand Up@@ -128,7 +129,8 @@ Custom discrete wavelets are also supported through the

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> def format_array(arr):
... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand DownExpand Up@@ -171,7 +173,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> wavelet = pywt.Wavelet('db2')
Expand All@@ -186,7 +189,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> wavelet = pywt.Wavelet('bior3.5')
Expand DownExpand Up@@ -239,7 +243,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt, math
>>> c = math.sqrt(2)/2
Expand DownExpand Up@@ -273,7 +278,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -328,7 +334,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -358,7 +365,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All@@ -375,7 +383,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

**Example:**

.. sourcecode:: python
.. try_examples::
:button_text: Try it in your browser!

>>> import pywt
>>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down
3 changes: 3 additions & 0 deletions doc/source/try_examples.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"global_min_height": "600px"
}
2 changes: 1 addition & 1 deletion pywt/_cwt.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,7 +96,7 @@ def cwt(data, scales, wavelet, sampling_period=1., method='conv', axis=-1):
>>> coef, freqs=pywt.cwt(y,np.arange(1,129),'gaus1')
>>> plt.matshow(coef) # doctest: +SKIP
>>> plt.show() # doctest: +SKIP
----------

>>> import pywt
>>> import numpy as np
>>> import matplotlib.pyplot as plt
Expand Down
10 changes: 10 additions & 0 deletions pywt/data/_wavelab_signals.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,16 @@ def demo_signal(name='Bumps', n=None):
test signals are provided with permission of Dr. Donoho to encourage
reproducible research.

Examples
--------
>>> import pywt
>>> camera = pywt.data.camera()
>>> doppler = pywt.data.demo_signal('doppler', 1024)
>>> available_signals = pywt.data.demo_signal('list')
>>> print(available_signals)



"""
if name.lower() == 'list':
return _implemented_signals
Expand Down
2 changes: 2 additions & 0 deletions util/readthedocs/requirements.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
matplotlib
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Initial steps towards interactive documentation via JupyterLite#728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rgommers
merged 11 commits into

from

Mar 28, 2024
 Merged


Initial steps towards interactive documentation via JupyterLite
#728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
fac14a9

DOC: ignore unneeded directories and databases


agriyakhetarpal Mar 14, 2024
534833e

DOC: add `jupyterlite-sphinx` to RTD requirements


agriyakhetarpal Mar 14, 2024
ee7df9b

DOC: start to configure JupyterLite


agriyakhetarpal Mar 14, 2024
803ca13

DOC: ship a Pyodide kernel on RTD


agriyakhetarpal Mar 14, 2024
dcb3088

DOC: Reconfigure admonition for Pyodide kernels


agriyakhetarpal Mar 15, 2024
9aaf45b

DOC: Add custom CSS to style "Try" button


agriyakhetarpal Mar 22, 2024
f15c822

DOC: Add a global minimum height for notebooks


agriyakhetarpal Mar 22, 2024
6d1145e

DOC: Move example for `pywt.data.demo_signal()`


agriyakhetarpal Mar 22, 2024
fbb063a

DOC: Update SciPy intersphinx target location


agriyakhetarpal Mar 22, 2024
68a2f41

DOC: `.. sourcecode::` ➡️ `..try_examples::`


agriyakhetarpal Mar 22, 2024
7977ff8

DOC: Add custom `:button_text:` for all examples


agriyakhetarpal Mar 22, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ __pycache__
*.egg-info
dist
build
_build
.installed.cfg

# Installer logs
Expand All@@ -19,6 +20,11 @@ pip-log.txt
.coverage
.tox

# Sphinx documentation
doc/_build/
doc/build/
.jupyterlite.doit.db

# Editors
.idea
.project
Expand Down

27 changes: 27 additions & 0 deletions
doc/source/_static/pywavelets.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
/* Custom CSS rules for the interactive documentation button */

.try_examples_button {
 color: white;
 background-color: #0054a6;
 border: none;
 padding: 5px 10px;
 border-radius: 10px;
 margin-bottom: 5px;
 box-shadow: 0 2px 5px rgba(108,108,108,0.2);
 font-weight: bold;
 font-size: small;
}

.try_examples_button:hover {
background-color: #0066cc;
transform: scale(1.02);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
cursor: pointer;
}

.try_examples_button_container {
 display: flex;
 justify-content: flex-start;
 gap: 10px;
 margin-bottom: 20px;
}

25 changes: 23 additions & 2 deletions
doc/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
 'jupyterlite_sphinx',
 'matplotlib.sphinxext.plot_directive',
 'numpydoc',
 'sphinx.ext.autodoc',
Expand DownExpand Up@@ -193,6 +194,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# CSS files to include in the build. The file path should be relative to the
# _static directory.
html_css_files = [
 "pywavelets.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand DownExpand Up@@ -282,8 +289,22 @@

# -- Options for intersphinx extension ---------------------------------------

# Intersphinx to get Numpy and other targets
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
 'numpy': ('https://numpy.org/devdocs', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/', None),
 }

# -- Options for JupyterLite -------------------------------------------------

global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = (
"""These interactive examples with JupyterLite are experimental and
may not always work as expected. The execution of cells containing import
statements can result in high bandwidth usage and may take a long time to
load. They may not be in sync with the latest PyWavelets release.

Shall you encounter any issues, please feel free to report them on the
[PyWavelets issue tracker](https://github.com/PyWavelets/pywt/issues)."""
)

12 changes: 8 additions & 4 deletions
doc/source/ref/cwt.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,9 +89,11 @@ Continuous Wavelet Families
A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 wavlist = pywt.wavelist(kind='continuous')
 >>> import pywt
 >>> wavelist = pywt.wavelist(kind='continuous')

Here is an overview of all available wavelets for ``cwt``. Note, that they can be
customized by passing parameters such as ``center_frequency`` and ``bandwidth_frequency``
Expand DownExpand Up@@ -205,7 +207,8 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
``scale = 1``. This is above the Nyquist rate of 50 Hz, so for this
particular wavelet, one would analyze a signal using ``scales >= 2``.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand DownExpand Up@@ -235,7 +238,8 @@ the input frequency in this function is normalized by 1/dt, or the sampling
frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand Down

9 changes: 0 additions & 9 deletions
doc/source/ref/other-functions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,12 +64,3 @@ Each can be loaded via a function of the same name.

.. currentmodule:: pywt.data
.. autofunction:: demo_signal

**Example:**

.. sourcecode:: python

 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')

12 changes: 7 additions & 5 deletions
doc/source/ref/signal-extension-modes.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,10 @@ computations can be performed with the `periodization`_ mode:
 smallest possible number of decomposition coefficients. :ref:`IDWT <ref-idwt>` must be
 performed with the same mode.

**Example:**
**Example:**

 .. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> print(pywt.Modes.modes)
Expand All@@ -104,7 +105,8 @@ signal to an even length prior to using periodic boundary conditions.
Notice that you can use any of the following ways of passing wavelet and mode
parameters:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand DownExpand Up@@ -142,8 +144,8 @@ Padding using PyWavelets Signal Extension Modes - ``pad``

.. autofunction:: pad

Pywavelets provides a function, :func:`pad`, that operate like
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
Pywavelets provides a function, :func:`pad`, that operates like
:func:`numpy.pad`, but supports the PyWavelets signal extension modes
discussed above. For efficiency, the DWT routines in PyWavelets do not
expclitly create padded signals using this function. It can be used to manually
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
Expand Down

27 changes: 18 additions & 9 deletions
doc/source/ref/wavelets.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db1')
Expand DownExpand Up@@ -128,7 +129,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> def format_array(arr):
 ... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand DownExpand Up@@ -171,7 +173,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db2')
Expand All@@ -186,7 +189,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('bior3.5')
Expand DownExpand Up@@ -239,7 +243,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt, math
 >>> c = math.sqrt(2)/2
Expand DownExpand Up@@ -273,7 +278,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -328,7 +334,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -358,7 +365,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All@@ -375,7 +383,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down

3 changes: 3 additions & 0 deletions
doc/source/try_examples.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
 "global_min_height": "600px"
}

2 changes: 1 addition & 1 deletion
pywt/_cwt.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,7 +96,7 @@ def cwt(data, scales, wavelet, sampling_period=1., method='conv', axis=-1):
 >>> coef, freqs=pywt.cwt(y,np.arange(1,129),'gaus1')
 >>> plt.matshow(coef) # doctest: +SKIP
 >>> plt.show() # doctest: +SKIP
 ----------

 >>> import pywt
 >>> import numpy as np
 >>> import matplotlib.pyplot as plt
Expand Down

10 changes: 10 additions & 0 deletions
pywt/data/_wavelab_signals.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,16 @@ def demo_signal(name='Bumps', n=None):
 test signals are provided with permission of Dr. Donoho to encourage
 reproducible research.

 Examples
 --------
 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')
 >>> print(available_signals)



 """
 if name.lower() == 'list':
 return _implemented_signals
Expand Down

2 changes: 2 additions & 0 deletions
util/readthedocs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
matplotlib
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Initial steps towards interactive documentation via JupyterLite#728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rgommers
merged 11 commits into

from

Mar 28, 2024
 Merged


Initial steps towards interactive documentation via JupyterLite
#728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
fac14a9

DOC: ignore unneeded directories and databases


agriyakhetarpal Mar 14, 2024
534833e

DOC: add `jupyterlite-sphinx` to RTD requirements


agriyakhetarpal Mar 14, 2024
ee7df9b

DOC: start to configure JupyterLite


agriyakhetarpal Mar 14, 2024
803ca13

DOC: ship a Pyodide kernel on RTD


agriyakhetarpal Mar 14, 2024
dcb3088

DOC: Reconfigure admonition for Pyodide kernels


agriyakhetarpal Mar 15, 2024
9aaf45b

DOC: Add custom CSS to style "Try" button


agriyakhetarpal Mar 22, 2024
f15c822

DOC: Add a global minimum height for notebooks


agriyakhetarpal Mar 22, 2024
6d1145e

DOC: Move example for `pywt.data.demo_signal()`


agriyakhetarpal Mar 22, 2024
fbb063a

DOC: Update SciPy intersphinx target location


agriyakhetarpal Mar 22, 2024
68a2f41

DOC: `.. sourcecode::` ➡️ `..try_examples::`


agriyakhetarpal Mar 22, 2024
7977ff8

DOC: Add custom `:button_text:` for all examples


agriyakhetarpal Mar 22, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ __pycache__
*.egg-info
dist
build
_build
.installed.cfg

# Installer logs
Expand All@@ -19,6 +20,11 @@ pip-log.txt
.coverage
.tox

# Sphinx documentation
doc/_build/
doc/build/
.jupyterlite.doit.db

# Editors
.idea
.project
Expand Down

27 changes: 27 additions & 0 deletions
doc/source/_static/pywavelets.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
/* Custom CSS rules for the interactive documentation button */

.try_examples_button {
 color: white;
 background-color: #0054a6;
 border: none;
 padding: 5px 10px;
 border-radius: 10px;
 margin-bottom: 5px;
 box-shadow: 0 2px 5px rgba(108,108,108,0.2);
 font-weight: bold;
 font-size: small;
}

.try_examples_button:hover {
background-color: #0066cc;
transform: scale(1.02);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
cursor: pointer;
}

.try_examples_button_container {
 display: flex;
 justify-content: flex-start;
 gap: 10px;
 margin-bottom: 20px;
}

25 changes: 23 additions & 2 deletions
doc/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
 'jupyterlite_sphinx',
 'matplotlib.sphinxext.plot_directive',
 'numpydoc',
 'sphinx.ext.autodoc',
Expand DownExpand Up@@ -193,6 +194,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# CSS files to include in the build. The file path should be relative to the
# _static directory.
html_css_files = [
 "pywavelets.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand DownExpand Up@@ -282,8 +289,22 @@

# -- Options for intersphinx extension ---------------------------------------

# Intersphinx to get Numpy and other targets
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
 'numpy': ('https://numpy.org/devdocs', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/', None),
 }

# -- Options for JupyterLite -------------------------------------------------

global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = (
"""These interactive examples with JupyterLite are experimental and
may not always work as expected. The execution of cells containing import
statements can result in high bandwidth usage and may take a long time to
load. They may not be in sync with the latest PyWavelets release.

Shall you encounter any issues, please feel free to report them on the
[PyWavelets issue tracker](https://github.com/PyWavelets/pywt/issues)."""
)

12 changes: 8 additions & 4 deletions
doc/source/ref/cwt.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,9 +89,11 @@ Continuous Wavelet Families
A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 wavlist = pywt.wavelist(kind='continuous')
 >>> import pywt
 >>> wavelist = pywt.wavelist(kind='continuous')

Here is an overview of all available wavelets for ``cwt``. Note, that they can be
customized by passing parameters such as ``center_frequency`` and ``bandwidth_frequency``
Expand DownExpand Up@@ -205,7 +207,8 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
``scale = 1``. This is above the Nyquist rate of 50 Hz, so for this
particular wavelet, one would analyze a signal using ``scales >= 2``.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand DownExpand Up@@ -235,7 +238,8 @@ the input frequency in this function is normalized by 1/dt, or the sampling
frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand Down

9 changes: 0 additions & 9 deletions
doc/source/ref/other-functions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,12 +64,3 @@ Each can be loaded via a function of the same name.

.. currentmodule:: pywt.data
.. autofunction:: demo_signal

**Example:**

.. sourcecode:: python

 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')

12 changes: 7 additions & 5 deletions
doc/source/ref/signal-extension-modes.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,10 @@ computations can be performed with the `periodization`_ mode:
 smallest possible number of decomposition coefficients. :ref:`IDWT <ref-idwt>` must be
 performed with the same mode.

**Example:**
**Example:**

 .. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> print(pywt.Modes.modes)
Expand All@@ -104,7 +105,8 @@ signal to an even length prior to using periodic boundary conditions.
Notice that you can use any of the following ways of passing wavelet and mode
parameters:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand DownExpand Up@@ -142,8 +144,8 @@ Padding using PyWavelets Signal Extension Modes - ``pad``

.. autofunction:: pad

Pywavelets provides a function, :func:`pad`, that operate like
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
Pywavelets provides a function, :func:`pad`, that operates like
:func:`numpy.pad`, but supports the PyWavelets signal extension modes
discussed above. For efficiency, the DWT routines in PyWavelets do not
expclitly create padded signals using this function. It can be used to manually
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
Expand Down

27 changes: 18 additions & 9 deletions
doc/source/ref/wavelets.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db1')
Expand DownExpand Up@@ -128,7 +129,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> def format_array(arr):
 ... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand DownExpand Up@@ -171,7 +173,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db2')
Expand All@@ -186,7 +189,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('bior3.5')
Expand DownExpand Up@@ -239,7 +243,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt, math
 >>> c = math.sqrt(2)/2
Expand DownExpand Up@@ -273,7 +278,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -328,7 +334,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -358,7 +365,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All@@ -375,7 +383,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down

3 changes: 3 additions & 0 deletions
doc/source/try_examples.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
 "global_min_height": "600px"
}

2 changes: 1 addition & 1 deletion
pywt/_cwt.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,7 +96,7 @@ def cwt(data, scales, wavelet, sampling_period=1., method='conv', axis=-1):
 >>> coef, freqs=pywt.cwt(y,np.arange(1,129),'gaus1')
 >>> plt.matshow(coef) # doctest: +SKIP
 >>> plt.show() # doctest: +SKIP
 ----------

 >>> import pywt
 >>> import numpy as np
 >>> import matplotlib.pyplot as plt
Expand Down

10 changes: 10 additions & 0 deletions
pywt/data/_wavelab_signals.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,16 @@ def demo_signal(name='Bumps', n=None):
 test signals are provided with permission of Dr. Donoho to encourage
 reproducible research.

 Examples
 --------
 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')
 >>> print(available_signals)



 """
 if name.lower() == 'list':
 return _implemented_signals
Expand Down

2 changes: 2 additions & 0 deletions
util/readthedocs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
matplotlib
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Initial steps towards interactive documentation via JupyterLite#728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rgommers
merged 11 commits into

from

Mar 28, 2024
 Merged


Initial steps towards interactive documentation via JupyterLite
#728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
fac14a9

DOC: ignore unneeded directories and databases


agriyakhetarpal Mar 14, 2024
534833e

DOC: add `jupyterlite-sphinx` to RTD requirements


agriyakhetarpal Mar 14, 2024
ee7df9b

DOC: start to configure JupyterLite


agriyakhetarpal Mar 14, 2024
803ca13

DOC: ship a Pyodide kernel on RTD


agriyakhetarpal Mar 14, 2024
dcb3088

DOC: Reconfigure admonition for Pyodide kernels


agriyakhetarpal Mar 15, 2024
9aaf45b

DOC: Add custom CSS to style "Try" button


agriyakhetarpal Mar 22, 2024
f15c822

DOC: Add a global minimum height for notebooks


agriyakhetarpal Mar 22, 2024
6d1145e

DOC: Move example for `pywt.data.demo_signal()`


agriyakhetarpal Mar 22, 2024
fbb063a

DOC: Update SciPy intersphinx target location


agriyakhetarpal Mar 22, 2024
68a2f41

DOC: `.. sourcecode::` ➡️ `..try_examples::`


agriyakhetarpal Mar 22, 2024
7977ff8

DOC: Add custom `:button_text:` for all examples


agriyakhetarpal Mar 22, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ __pycache__
*.egg-info
dist
build
_build
.installed.cfg

# Installer logs
Expand All@@ -19,6 +20,11 @@ pip-log.txt
.coverage
.tox

# Sphinx documentation
doc/_build/
doc/build/
.jupyterlite.doit.db

# Editors
.idea
.project
Expand Down

27 changes: 27 additions & 0 deletions
doc/source/_static/pywavelets.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
/* Custom CSS rules for the interactive documentation button */

.try_examples_button {
 color: white;
 background-color: #0054a6;
 border: none;
 padding: 5px 10px;
 border-radius: 10px;
 margin-bottom: 5px;
 box-shadow: 0 2px 5px rgba(108,108,108,0.2);
 font-weight: bold;
 font-size: small;
}

.try_examples_button:hover {
background-color: #0066cc;
transform: scale(1.02);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
cursor: pointer;
}

.try_examples_button_container {
 display: flex;
 justify-content: flex-start;
 gap: 10px;
 margin-bottom: 20px;
}

25 changes: 23 additions & 2 deletions
doc/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
 'jupyterlite_sphinx',
 'matplotlib.sphinxext.plot_directive',
 'numpydoc',
 'sphinx.ext.autodoc',
Expand DownExpand Up@@ -193,6 +194,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# CSS files to include in the build. The file path should be relative to the
# _static directory.
html_css_files = [
 "pywavelets.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand DownExpand Up@@ -282,8 +289,22 @@

# -- Options for intersphinx extension ---------------------------------------

# Intersphinx to get Numpy and other targets
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
 'numpy': ('https://numpy.org/devdocs', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/', None),
 }

# -- Options for JupyterLite -------------------------------------------------

global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = (
"""These interactive examples with JupyterLite are experimental and
may not always work as expected. The execution of cells containing import
statements can result in high bandwidth usage and may take a long time to
load. They may not be in sync with the latest PyWavelets release.

Shall you encounter any issues, please feel free to report them on the
[PyWavelets issue tracker](https://github.com/PyWavelets/pywt/issues)."""
)

12 changes: 8 additions & 4 deletions
doc/source/ref/cwt.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,9 +89,11 @@ Continuous Wavelet Families
A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 wavlist = pywt.wavelist(kind='continuous')
 >>> import pywt
 >>> wavelist = pywt.wavelist(kind='continuous')

Here is an overview of all available wavelets for ``cwt``. Note, that they can be
customized by passing parameters such as ``center_frequency`` and ``bandwidth_frequency``
Expand DownExpand Up@@ -205,7 +207,8 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
``scale = 1``. This is above the Nyquist rate of 50 Hz, so for this
particular wavelet, one would analyze a signal using ``scales >= 2``.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand DownExpand Up@@ -235,7 +238,8 @@ the input frequency in this function is normalized by 1/dt, or the sampling
frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand Down

9 changes: 0 additions & 9 deletions
doc/source/ref/other-functions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,12 +64,3 @@ Each can be loaded via a function of the same name.

.. currentmodule:: pywt.data
.. autofunction:: demo_signal

**Example:**

.. sourcecode:: python

 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')

12 changes: 7 additions & 5 deletions
doc/source/ref/signal-extension-modes.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,10 @@ computations can be performed with the `periodization`_ mode:
 smallest possible number of decomposition coefficients. :ref:`IDWT <ref-idwt>` must be
 performed with the same mode.

**Example:**
**Example:**

 .. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> print(pywt.Modes.modes)
Expand All@@ -104,7 +105,8 @@ signal to an even length prior to using periodic boundary conditions.
Notice that you can use any of the following ways of passing wavelet and mode
parameters:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand DownExpand Up@@ -142,8 +144,8 @@ Padding using PyWavelets Signal Extension Modes - ``pad``

.. autofunction:: pad

Pywavelets provides a function, :func:`pad`, that operate like
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
Pywavelets provides a function, :func:`pad`, that operates like
:func:`numpy.pad`, but supports the PyWavelets signal extension modes
discussed above. For efficiency, the DWT routines in PyWavelets do not
expclitly create padded signals using this function. It can be used to manually
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
Expand Down

27 changes: 18 additions & 9 deletions
doc/source/ref/wavelets.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db1')
Expand DownExpand Up@@ -128,7 +129,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> def format_array(arr):
 ... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand DownExpand Up@@ -171,7 +173,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db2')
Expand All@@ -186,7 +189,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('bior3.5')
Expand DownExpand Up@@ -239,7 +243,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt, math
 >>> c = math.sqrt(2)/2
Expand DownExpand Up@@ -273,7 +278,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -328,7 +334,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -358,7 +365,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All@@ -375,7 +383,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down

3 changes: 3 additions & 0 deletions
doc/source/try_examples.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
 "global_min_height": "600px"
}

2 changes: 1 addition & 1 deletion
pywt/_cwt.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,7 +96,7 @@ def cwt(data, scales, wavelet, sampling_period=1., method='conv', axis=-1):
 >>> coef, freqs=pywt.cwt(y,np.arange(1,129),'gaus1')
 >>> plt.matshow(coef) # doctest: +SKIP
 >>> plt.show() # doctest: +SKIP
 ----------

 >>> import pywt
 >>> import numpy as np
 >>> import matplotlib.pyplot as plt
Expand Down

10 changes: 10 additions & 0 deletions
pywt/data/_wavelab_signals.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,16 @@ def demo_signal(name='Bumps', n=None):
 test signals are provided with permission of Dr. Donoho to encourage
 reproducible research.

 Examples
 --------
 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')
 >>> print(available_signals)



 """
 if name.lower() == 'list':
 return _implemented_signals
Expand Down

2 changes: 2 additions & 0 deletions
util/readthedocs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
matplotlib
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Initial steps towards interactive documentation via JupyterLite#728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rgommers
merged 11 commits into

from

Mar 28, 2024
 Merged


Initial steps towards interactive documentation via JupyterLite
#728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
fac14a9

DOC: ignore unneeded directories and databases


agriyakhetarpal Mar 14, 2024
534833e

DOC: add `jupyterlite-sphinx` to RTD requirements


agriyakhetarpal Mar 14, 2024
ee7df9b

DOC: start to configure JupyterLite


agriyakhetarpal Mar 14, 2024
803ca13

DOC: ship a Pyodide kernel on RTD


agriyakhetarpal Mar 14, 2024
dcb3088

DOC: Reconfigure admonition for Pyodide kernels


agriyakhetarpal Mar 15, 2024
9aaf45b

DOC: Add custom CSS to style "Try" button


agriyakhetarpal Mar 22, 2024
f15c822

DOC: Add a global minimum height for notebooks


agriyakhetarpal Mar 22, 2024
6d1145e

DOC: Move example for `pywt.data.demo_signal()`


agriyakhetarpal Mar 22, 2024
fbb063a

DOC: Update SciPy intersphinx target location


agriyakhetarpal Mar 22, 2024
68a2f41

DOC: `.. sourcecode::` ➡️ `..try_examples::`


agriyakhetarpal Mar 22, 2024
7977ff8

DOC: Add custom `:button_text:` for all examples


agriyakhetarpal Mar 22, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ __pycache__
*.egg-info
dist
build
_build
.installed.cfg

# Installer logs
Expand All@@ -19,6 +20,11 @@ pip-log.txt
.coverage
.tox

# Sphinx documentation
doc/_build/
doc/build/
.jupyterlite.doit.db

# Editors
.idea
.project
Expand Down

27 changes: 27 additions & 0 deletions
doc/source/_static/pywavelets.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
/* Custom CSS rules for the interactive documentation button */

.try_examples_button {
 color: white;
 background-color: #0054a6;
 border: none;
 padding: 5px 10px;
 border-radius: 10px;
 margin-bottom: 5px;
 box-shadow: 0 2px 5px rgba(108,108,108,0.2);
 font-weight: bold;
 font-size: small;
}

.try_examples_button:hover {
background-color: #0066cc;
transform: scale(1.02);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
cursor: pointer;
}

.try_examples_button_container {
 display: flex;
 justify-content: flex-start;
 gap: 10px;
 margin-bottom: 20px;
}

25 changes: 23 additions & 2 deletions
doc/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
 'jupyterlite_sphinx',
 'matplotlib.sphinxext.plot_directive',
 'numpydoc',
 'sphinx.ext.autodoc',
Expand DownExpand Up@@ -193,6 +194,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# CSS files to include in the build. The file path should be relative to the
# _static directory.
html_css_files = [
 "pywavelets.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand DownExpand Up@@ -282,8 +289,22 @@

# -- Options for intersphinx extension ---------------------------------------

# Intersphinx to get Numpy and other targets
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
 'numpy': ('https://numpy.org/devdocs', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/', None),
 }

# -- Options for JupyterLite -------------------------------------------------

global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = (
"""These interactive examples with JupyterLite are experimental and
may not always work as expected. The execution of cells containing import
statements can result in high bandwidth usage and may take a long time to
load. They may not be in sync with the latest PyWavelets release.

Shall you encounter any issues, please feel free to report them on the
[PyWavelets issue tracker](https://github.com/PyWavelets/pywt/issues)."""
)

12 changes: 8 additions & 4 deletions
doc/source/ref/cwt.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,9 +89,11 @@ Continuous Wavelet Families
A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 wavlist = pywt.wavelist(kind='continuous')
 >>> import pywt
 >>> wavelist = pywt.wavelist(kind='continuous')

Here is an overview of all available wavelets for ``cwt``. Note, that they can be
customized by passing parameters such as ``center_frequency`` and ``bandwidth_frequency``
Expand DownExpand Up@@ -205,7 +207,8 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
``scale = 1``. This is above the Nyquist rate of 50 Hz, so for this
particular wavelet, one would analyze a signal using ``scales >= 2``.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand DownExpand Up@@ -235,7 +238,8 @@ the input frequency in this function is normalized by 1/dt, or the sampling
frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand Down

9 changes: 0 additions & 9 deletions
doc/source/ref/other-functions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,12 +64,3 @@ Each can be loaded via a function of the same name.

.. currentmodule:: pywt.data
.. autofunction:: demo_signal

**Example:**

.. sourcecode:: python

 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')

12 changes: 7 additions & 5 deletions
doc/source/ref/signal-extension-modes.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,10 @@ computations can be performed with the `periodization`_ mode:
 smallest possible number of decomposition coefficients. :ref:`IDWT <ref-idwt>` must be
 performed with the same mode.

**Example:**
**Example:**

 .. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> print(pywt.Modes.modes)
Expand All@@ -104,7 +105,8 @@ signal to an even length prior to using periodic boundary conditions.
Notice that you can use any of the following ways of passing wavelet and mode
parameters:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand DownExpand Up@@ -142,8 +144,8 @@ Padding using PyWavelets Signal Extension Modes - ``pad``

.. autofunction:: pad

Pywavelets provides a function, :func:`pad`, that operate like
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
Pywavelets provides a function, :func:`pad`, that operates like
:func:`numpy.pad`, but supports the PyWavelets signal extension modes
discussed above. For efficiency, the DWT routines in PyWavelets do not
expclitly create padded signals using this function. It can be used to manually
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
Expand Down

27 changes: 18 additions & 9 deletions
doc/source/ref/wavelets.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db1')
Expand DownExpand Up@@ -128,7 +129,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> def format_array(arr):
 ... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand DownExpand Up@@ -171,7 +173,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db2')
Expand All@@ -186,7 +189,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('bior3.5')
Expand DownExpand Up@@ -239,7 +243,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt, math
 >>> c = math.sqrt(2)/2
Expand DownExpand Up@@ -273,7 +278,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -328,7 +334,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -358,7 +365,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All@@ -375,7 +383,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down

3 changes: 3 additions & 0 deletions
doc/source/try_examples.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
 "global_min_height": "600px"
}

2 changes: 1 addition & 1 deletion
pywt/_cwt.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,7 +96,7 @@ def cwt(data, scales, wavelet, sampling_period=1., method='conv', axis=-1):
 >>> coef, freqs=pywt.cwt(y,np.arange(1,129),'gaus1')
 >>> plt.matshow(coef) # doctest: +SKIP
 >>> plt.show() # doctest: +SKIP
 ----------

 >>> import pywt
 >>> import numpy as np
 >>> import matplotlib.pyplot as plt
Expand Down

10 changes: 10 additions & 0 deletions
pywt/data/_wavelab_signals.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,16 @@ def demo_signal(name='Bumps', n=None):
 test signals are provided with permission of Dr. Donoho to encourage
 reproducible research.

 Examples
 --------
 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')
 >>> print(available_signals)



 """
 if name.lower() == 'list':
 return _implemented_signals
Expand Down

2 changes: 2 additions & 0 deletions
util/readthedocs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
matplotlib
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Initial steps towards interactive documentation via JupyterLite#728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rgommers
merged 11 commits into

from

Mar 28, 2024
 Merged


Initial steps towards interactive documentation via JupyterLite
#728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
fac14a9

DOC: ignore unneeded directories and databases


agriyakhetarpal Mar 14, 2024
534833e

DOC: add `jupyterlite-sphinx` to RTD requirements


agriyakhetarpal Mar 14, 2024
ee7df9b

DOC: start to configure JupyterLite


agriyakhetarpal Mar 14, 2024
803ca13

DOC: ship a Pyodide kernel on RTD


agriyakhetarpal Mar 14, 2024
dcb3088

DOC: Reconfigure admonition for Pyodide kernels


agriyakhetarpal Mar 15, 2024
9aaf45b

DOC: Add custom CSS to style "Try" button


agriyakhetarpal Mar 22, 2024
f15c822

DOC: Add a global minimum height for notebooks


agriyakhetarpal Mar 22, 2024
6d1145e

DOC: Move example for `pywt.data.demo_signal()`


agriyakhetarpal Mar 22, 2024
fbb063a

DOC: Update SciPy intersphinx target location


agriyakhetarpal Mar 22, 2024
68a2f41

DOC: `.. sourcecode::` ➡️ `..try_examples::`


agriyakhetarpal Mar 22, 2024
7977ff8

DOC: Add custom `:button_text:` for all examples


agriyakhetarpal Mar 22, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ __pycache__
*.egg-info
dist
build
_build
.installed.cfg

# Installer logs
Expand All@@ -19,6 +20,11 @@ pip-log.txt
.coverage
.tox

# Sphinx documentation
doc/_build/
doc/build/
.jupyterlite.doit.db

# Editors
.idea
.project
Expand Down

27 changes: 27 additions & 0 deletions
doc/source/_static/pywavelets.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
/* Custom CSS rules for the interactive documentation button */

.try_examples_button {
 color: white;
 background-color: #0054a6;
 border: none;
 padding: 5px 10px;
 border-radius: 10px;
 margin-bottom: 5px;
 box-shadow: 0 2px 5px rgba(108,108,108,0.2);
 font-weight: bold;
 font-size: small;
}

.try_examples_button:hover {
background-color: #0066cc;
transform: scale(1.02);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
cursor: pointer;
}

.try_examples_button_container {
 display: flex;
 justify-content: flex-start;
 gap: 10px;
 margin-bottom: 20px;
}

25 changes: 23 additions & 2 deletions
doc/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
 'jupyterlite_sphinx',
 'matplotlib.sphinxext.plot_directive',
 'numpydoc',
 'sphinx.ext.autodoc',
Expand DownExpand Up@@ -193,6 +194,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# CSS files to include in the build. The file path should be relative to the
# _static directory.
html_css_files = [
 "pywavelets.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand DownExpand Up@@ -282,8 +289,22 @@

# -- Options for intersphinx extension ---------------------------------------

# Intersphinx to get Numpy and other targets
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
 'numpy': ('https://numpy.org/devdocs', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/', None),
 }

# -- Options for JupyterLite -------------------------------------------------

global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = (
"""These interactive examples with JupyterLite are experimental and
may not always work as expected. The execution of cells containing import
statements can result in high bandwidth usage and may take a long time to
load. They may not be in sync with the latest PyWavelets release.

Shall you encounter any issues, please feel free to report them on the
[PyWavelets issue tracker](https://github.com/PyWavelets/pywt/issues)."""
)

12 changes: 8 additions & 4 deletions
doc/source/ref/cwt.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,9 +89,11 @@ Continuous Wavelet Families
A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 wavlist = pywt.wavelist(kind='continuous')
 >>> import pywt
 >>> wavelist = pywt.wavelist(kind='continuous')

Here is an overview of all available wavelets for ``cwt``. Note, that they can be
customized by passing parameters such as ``center_frequency`` and ``bandwidth_frequency``
Expand DownExpand Up@@ -205,7 +207,8 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
``scale = 1``. This is above the Nyquist rate of 50 Hz, so for this
particular wavelet, one would analyze a signal using ``scales >= 2``.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand DownExpand Up@@ -235,7 +238,8 @@ the input frequency in this function is normalized by 1/dt, or the sampling
frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand Down

9 changes: 0 additions & 9 deletions
doc/source/ref/other-functions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,12 +64,3 @@ Each can be loaded via a function of the same name.

.. currentmodule:: pywt.data
.. autofunction:: demo_signal

**Example:**

.. sourcecode:: python

 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')

12 changes: 7 additions & 5 deletions
doc/source/ref/signal-extension-modes.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,10 @@ computations can be performed with the `periodization`_ mode:
 smallest possible number of decomposition coefficients. :ref:`IDWT <ref-idwt>` must be
 performed with the same mode.

**Example:**
**Example:**

 .. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> print(pywt.Modes.modes)
Expand All@@ -104,7 +105,8 @@ signal to an even length prior to using periodic boundary conditions.
Notice that you can use any of the following ways of passing wavelet and mode
parameters:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand DownExpand Up@@ -142,8 +144,8 @@ Padding using PyWavelets Signal Extension Modes - ``pad``

.. autofunction:: pad

Pywavelets provides a function, :func:`pad`, that operate like
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
Pywavelets provides a function, :func:`pad`, that operates like
:func:`numpy.pad`, but supports the PyWavelets signal extension modes
discussed above. For efficiency, the DWT routines in PyWavelets do not
expclitly create padded signals using this function. It can be used to manually
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
Expand Down

27 changes: 18 additions & 9 deletions
doc/source/ref/wavelets.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db1')
Expand DownExpand Up@@ -128,7 +129,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> def format_array(arr):
 ... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand DownExpand Up@@ -171,7 +173,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db2')
Expand All@@ -186,7 +189,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('bior3.5')
Expand DownExpand Up@@ -239,7 +243,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt, math
 >>> c = math.sqrt(2)/2
Expand DownExpand Up@@ -273,7 +278,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -328,7 +334,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -358,7 +365,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All@@ -375,7 +383,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down

3 changes: 3 additions & 0 deletions
doc/source/try_examples.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
 "global_min_height": "600px"
}

2 changes: 1 addition & 1 deletion
pywt/_cwt.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,7 +96,7 @@ def cwt(data, scales, wavelet, sampling_period=1., method='conv', axis=-1):
 >>> coef, freqs=pywt.cwt(y,np.arange(1,129),'gaus1')
 >>> plt.matshow(coef) # doctest: +SKIP
 >>> plt.show() # doctest: +SKIP
 ----------

 >>> import pywt
 >>> import numpy as np
 >>> import matplotlib.pyplot as plt
Expand Down

10 changes: 10 additions & 0 deletions
pywt/data/_wavelab_signals.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,16 @@ def demo_signal(name='Bumps', n=None):
 test signals are provided with permission of Dr. Donoho to encourage
 reproducible research.

 Examples
 --------
 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')
 >>> print(available_signals)



 """
 if name.lower() == 'list':
 return _implemented_signals
Expand Down

2 changes: 2 additions & 0 deletions
util/readthedocs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
matplotlib
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Initial steps towards interactive documentation via JupyterLite#728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rgommers
merged 11 commits into

from

Mar 28, 2024
 Merged


Initial steps towards interactive documentation via JupyterLite
#728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
fac14a9

DOC: ignore unneeded directories and databases


agriyakhetarpal Mar 14, 2024
534833e

DOC: add `jupyterlite-sphinx` to RTD requirements


agriyakhetarpal Mar 14, 2024
ee7df9b

DOC: start to configure JupyterLite


agriyakhetarpal Mar 14, 2024
803ca13

DOC: ship a Pyodide kernel on RTD


agriyakhetarpal Mar 14, 2024
dcb3088

DOC: Reconfigure admonition for Pyodide kernels


agriyakhetarpal Mar 15, 2024
9aaf45b

DOC: Add custom CSS to style "Try" button


agriyakhetarpal Mar 22, 2024
f15c822

DOC: Add a global minimum height for notebooks


agriyakhetarpal Mar 22, 2024
6d1145e

DOC: Move example for `pywt.data.demo_signal()`


agriyakhetarpal Mar 22, 2024
fbb063a

DOC: Update SciPy intersphinx target location


agriyakhetarpal Mar 22, 2024
68a2f41

DOC: `.. sourcecode::` ➡️ `..try_examples::`


agriyakhetarpal Mar 22, 2024
7977ff8

DOC: Add custom `:button_text:` for all examples


agriyakhetarpal Mar 22, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ __pycache__
*.egg-info
dist
build
_build
.installed.cfg

# Installer logs
Expand All@@ -19,6 +20,11 @@ pip-log.txt
.coverage
.tox

# Sphinx documentation
doc/_build/
doc/build/
.jupyterlite.doit.db

# Editors
.idea
.project
Expand Down

27 changes: 27 additions & 0 deletions
doc/source/_static/pywavelets.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
/* Custom CSS rules for the interactive documentation button */

.try_examples_button {
 color: white;
 background-color: #0054a6;
 border: none;
 padding: 5px 10px;
 border-radius: 10px;
 margin-bottom: 5px;
 box-shadow: 0 2px 5px rgba(108,108,108,0.2);
 font-weight: bold;
 font-size: small;
}

.try_examples_button:hover {
background-color: #0066cc;
transform: scale(1.02);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
cursor: pointer;
}

.try_examples_button_container {
 display: flex;
 justify-content: flex-start;
 gap: 10px;
 margin-bottom: 20px;
}

25 changes: 23 additions & 2 deletions
doc/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
 'jupyterlite_sphinx',
 'matplotlib.sphinxext.plot_directive',
 'numpydoc',
 'sphinx.ext.autodoc',
Expand DownExpand Up@@ -193,6 +194,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# CSS files to include in the build. The file path should be relative to the
# _static directory.
html_css_files = [
 "pywavelets.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand DownExpand Up@@ -282,8 +289,22 @@

# -- Options for intersphinx extension ---------------------------------------

# Intersphinx to get Numpy and other targets
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
 'numpy': ('https://numpy.org/devdocs', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/', None),
 }

# -- Options for JupyterLite -------------------------------------------------

global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = (
"""These interactive examples with JupyterLite are experimental and
may not always work as expected. The execution of cells containing import
statements can result in high bandwidth usage and may take a long time to
load. They may not be in sync with the latest PyWavelets release.

Shall you encounter any issues, please feel free to report them on the
[PyWavelets issue tracker](https://github.com/PyWavelets/pywt/issues)."""
)

12 changes: 8 additions & 4 deletions
doc/source/ref/cwt.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,9 +89,11 @@ Continuous Wavelet Families
A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 wavlist = pywt.wavelist(kind='continuous')
 >>> import pywt
 >>> wavelist = pywt.wavelist(kind='continuous')

Here is an overview of all available wavelets for ``cwt``. Note, that they can be
customized by passing parameters such as ``center_frequency`` and ``bandwidth_frequency``
Expand DownExpand Up@@ -205,7 +207,8 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
``scale = 1``. This is above the Nyquist rate of 50 Hz, so for this
particular wavelet, one would analyze a signal using ``scales >= 2``.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand DownExpand Up@@ -235,7 +238,8 @@ the input frequency in this function is normalized by 1/dt, or the sampling
frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand Down

9 changes: 0 additions & 9 deletions
doc/source/ref/other-functions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,12 +64,3 @@ Each can be loaded via a function of the same name.

.. currentmodule:: pywt.data
.. autofunction:: demo_signal

**Example:**

.. sourcecode:: python

 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')

12 changes: 7 additions & 5 deletions
doc/source/ref/signal-extension-modes.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,10 @@ computations can be performed with the `periodization`_ mode:
 smallest possible number of decomposition coefficients. :ref:`IDWT <ref-idwt>` must be
 performed with the same mode.

**Example:**
**Example:**

 .. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> print(pywt.Modes.modes)
Expand All@@ -104,7 +105,8 @@ signal to an even length prior to using periodic boundary conditions.
Notice that you can use any of the following ways of passing wavelet and mode
parameters:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand DownExpand Up@@ -142,8 +144,8 @@ Padding using PyWavelets Signal Extension Modes - ``pad``

.. autofunction:: pad

Pywavelets provides a function, :func:`pad`, that operate like
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
Pywavelets provides a function, :func:`pad`, that operates like
:func:`numpy.pad`, but supports the PyWavelets signal extension modes
discussed above. For efficiency, the DWT routines in PyWavelets do not
expclitly create padded signals using this function. It can be used to manually
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
Expand Down

27 changes: 18 additions & 9 deletions
doc/source/ref/wavelets.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db1')
Expand DownExpand Up@@ -128,7 +129,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> def format_array(arr):
 ... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand DownExpand Up@@ -171,7 +173,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db2')
Expand All@@ -186,7 +189,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('bior3.5')
Expand DownExpand Up@@ -239,7 +243,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt, math
 >>> c = math.sqrt(2)/2
Expand DownExpand Up@@ -273,7 +278,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -328,7 +334,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -358,7 +365,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All@@ -375,7 +383,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down

3 changes: 3 additions & 0 deletions
doc/source/try_examples.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
 "global_min_height": "600px"
}

2 changes: 1 addition & 1 deletion
pywt/_cwt.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,7 +96,7 @@ def cwt(data, scales, wavelet, sampling_period=1., method='conv', axis=-1):
 >>> coef, freqs=pywt.cwt(y,np.arange(1,129),'gaus1')
 >>> plt.matshow(coef) # doctest: +SKIP
 >>> plt.show() # doctest: +SKIP
 ----------

 >>> import pywt
 >>> import numpy as np
 >>> import matplotlib.pyplot as plt
Expand Down

10 changes: 10 additions & 0 deletions
pywt/data/_wavelab_signals.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,16 @@ def demo_signal(name='Bumps', n=None):
 test signals are provided with permission of Dr. Donoho to encourage
 reproducible research.

 Examples
 --------
 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')
 >>> print(available_signals)



 """
 if name.lower() == 'list':
 return _implemented_signals
Expand Down

2 changes: 2 additions & 0 deletions
util/readthedocs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
matplotlib
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Initial steps towards interactive documentation via JupyterLite#728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rgommers
merged 11 commits into

from

Mar 28, 2024
 Merged


Initial steps towards interactive documentation via JupyterLite
#728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
fac14a9

DOC: ignore unneeded directories and databases


agriyakhetarpal Mar 14, 2024
534833e

DOC: add `jupyterlite-sphinx` to RTD requirements


agriyakhetarpal Mar 14, 2024
ee7df9b

DOC: start to configure JupyterLite


agriyakhetarpal Mar 14, 2024
803ca13

DOC: ship a Pyodide kernel on RTD


agriyakhetarpal Mar 14, 2024
dcb3088

DOC: Reconfigure admonition for Pyodide kernels


agriyakhetarpal Mar 15, 2024
9aaf45b

DOC: Add custom CSS to style "Try" button


agriyakhetarpal Mar 22, 2024
f15c822

DOC: Add a global minimum height for notebooks


agriyakhetarpal Mar 22, 2024
6d1145e

DOC: Move example for `pywt.data.demo_signal()`


agriyakhetarpal Mar 22, 2024
fbb063a

DOC: Update SciPy intersphinx target location


agriyakhetarpal Mar 22, 2024
68a2f41

DOC: `.. sourcecode::` ➡️ `..try_examples::`


agriyakhetarpal Mar 22, 2024
7977ff8

DOC: Add custom `:button_text:` for all examples


agriyakhetarpal Mar 22, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ __pycache__
*.egg-info
dist
build
_build
.installed.cfg

# Installer logs
Expand All@@ -19,6 +20,11 @@ pip-log.txt
.coverage
.tox

# Sphinx documentation
doc/_build/
doc/build/
.jupyterlite.doit.db

# Editors
.idea
.project
Expand Down

27 changes: 27 additions & 0 deletions
doc/source/_static/pywavelets.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
/* Custom CSS rules for the interactive documentation button */

.try_examples_button {
 color: white;
 background-color: #0054a6;
 border: none;
 padding: 5px 10px;
 border-radius: 10px;
 margin-bottom: 5px;
 box-shadow: 0 2px 5px rgba(108,108,108,0.2);
 font-weight: bold;
 font-size: small;
}

.try_examples_button:hover {
background-color: #0066cc;
transform: scale(1.02);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
cursor: pointer;
}

.try_examples_button_container {
 display: flex;
 justify-content: flex-start;
 gap: 10px;
 margin-bottom: 20px;
}

25 changes: 23 additions & 2 deletions
doc/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
 'jupyterlite_sphinx',
 'matplotlib.sphinxext.plot_directive',
 'numpydoc',
 'sphinx.ext.autodoc',
Expand DownExpand Up@@ -193,6 +194,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# CSS files to include in the build. The file path should be relative to the
# _static directory.
html_css_files = [
 "pywavelets.css",
]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand DownExpand Up@@ -282,8 +289,22 @@

# -- Options for intersphinx extension ---------------------------------------

# Intersphinx to get Numpy and other targets
# Intersphinx to get NumPy, SciPy, and other targets
intersphinx_mapping = {
 'numpy': ('https://numpy.org/devdocs', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
 'scipy': ('https://docs.scipy.org/doc/scipy/', None),
 }

# -- Options for JupyterLite -------------------------------------------------

global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = (
"""These interactive examples with JupyterLite are experimental and
may not always work as expected. The execution of cells containing import
statements can result in high bandwidth usage and may take a long time to
load. They may not be in sync with the latest PyWavelets release.

Shall you encounter any issues, please feel free to report them on the
[PyWavelets issue tracker](https://github.com/PyWavelets/pywt/issues)."""
)

12 changes: 8 additions & 4 deletions
doc/source/ref/cwt.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,9 +89,11 @@ Continuous Wavelet Families
A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 wavlist = pywt.wavelist(kind='continuous')
 >>> import pywt
 >>> wavelist = pywt.wavelist(kind='continuous')

Here is an overview of all available wavelets for ``cwt``. Note, that they can be
customized by passing parameters such as ``center_frequency`` and ``bandwidth_frequency``
Expand DownExpand Up@@ -205,7 +207,8 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
``scale = 1``. This is above the Nyquist rate of 50 Hz, so for this
particular wavelet, one would analyze a signal using ``scales >= 2``.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand DownExpand Up@@ -235,7 +238,8 @@ the input frequency in this function is normalized by 1/dt, or the sampling
frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import numpy as np
 >>> import pywt
Expand Down

9 changes: 0 additions & 9 deletions
doc/source/ref/other-functions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,12 +64,3 @@ Each can be loaded via a function of the same name.

.. currentmodule:: pywt.data
.. autofunction:: demo_signal

**Example:**

.. sourcecode:: python

 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')

12 changes: 7 additions & 5 deletions
doc/source/ref/signal-extension-modes.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,9 +87,10 @@ computations can be performed with the `periodization`_ mode:
 smallest possible number of decomposition coefficients. :ref:`IDWT <ref-idwt>` must be
 performed with the same mode.

**Example:**
**Example:**

 .. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> print(pywt.Modes.modes)
Expand All@@ -104,7 +105,8 @@ signal to an even length prior to using periodic boundary conditions.
Notice that you can use any of the following ways of passing wavelet and mode
parameters:

.. sourcecode:: python
.. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand DownExpand Up@@ -142,8 +144,8 @@ Padding using PyWavelets Signal Extension Modes - ``pad``

.. autofunction:: pad

Pywavelets provides a function, :func:`pad`, that operate like
:func:`numpy.pad`, but supporting the PyWavelets signal extension modes
Pywavelets provides a function, :func:`pad`, that operates like
:func:`numpy.pad`, but supports the PyWavelets signal extension modes
discussed above. For efficiency, the DWT routines in PyWavelets do not
expclitly create padded signals using this function. It can be used to manually
prepad signals to reduce boundary effects in functions such as :func:`cwt` and
Expand Down

27 changes: 18 additions & 9 deletions
doc/source/ref/wavelets.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db1')
Expand DownExpand Up@@ -128,7 +129,8 @@ Custom discrete wavelets are also supported through the

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> def format_array(arr):
 ... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand DownExpand Up@@ -171,7 +173,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('db2')
Expand All@@ -186,7 +189,8 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.Wavelet('bior3.5')
Expand DownExpand Up@@ -239,7 +243,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt, math
 >>> c = math.sqrt(2)/2
Expand DownExpand Up@@ -273,7 +278,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -328,7 +334,8 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand DownExpand Up@@ -358,7 +365,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All@@ -375,7 +383,8 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``

 **Example:**

 .. sourcecode:: python
 .. try_examples::
 :button_text: Try it in your browser!

 >>> import pywt
 >>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down

3 changes: 3 additions & 0 deletions
doc/source/try_examples.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
 "global_min_height": "600px"
}

2 changes: 1 addition & 1 deletion
pywt/_cwt.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,7 +96,7 @@ def cwt(data, scales, wavelet, sampling_period=1., method='conv', axis=-1):
 >>> coef, freqs=pywt.cwt(y,np.arange(1,129),'gaus1')
 >>> plt.matshow(coef) # doctest: +SKIP
 >>> plt.show() # doctest: +SKIP
 ----------

 >>> import pywt
 >>> import numpy as np
 >>> import matplotlib.pyplot as plt
Expand Down

10 changes: 10 additions & 0 deletions
pywt/data/_wavelab_signals.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,16 @@ def demo_signal(name='Bumps', n=None):
 test signals are provided with permission of Dr. Donoho to encourage
 reproducible research.

 Examples
 --------
 >>> import pywt
 >>> camera = pywt.data.camera()
 >>> doppler = pywt.data.demo_signal('doppler', 1024)
 >>> available_signals = pywt.data.demo_signal('list')
 >>> print(available_signals)



 """
 if name.lower() == 'list':
 return _implemented_signals
Expand Down

2 changes: 2 additions & 0 deletions
util/readthedocs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
matplotlib
Expand Down