Skip to content
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

DOC, DEP: Remove custom :button_text directive option, bump jupyterlite-sphinx #737

Merged
merged 2 commits into from
May 1, 2024
Merged

DOC, DEP: Remove custom :button_text directive option, bump jupyterlite-sphinx #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2191163
DOC: Remove custom `:button_text` directive option
agriyakhetarpal Mar 30, 2024
51b3d4d
DEP: bump `jupyterlite-sphinx` to 0.14.0
agriyakhetarpal Apr 30, 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
3 changes: 0 additions & 3 deletions doc/source/ref/cwt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ A variety of continuous wavelets have been implemented. A list of the available
wavelet names compatible with ``cwt`` can be obtained by:

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

>>> import pywt
>>> wavelist = pywt.wavelist(kind='continuous')
Expand Down Expand Up @@ -208,7 +207,6 @@ sampled at 100 Hz, a center frequency of 1.0 corresponds to ~100 Hz at
particular wavelet, one would analyze a signal using ``scales >= 2``.

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

>>> import numpy as np
>>> import pywt
Expand Down Expand Up @@ -239,7 +237,6 @@ frequency fs. This function is useful for specifying the transform as a function
of frequency directly.

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

>>> import numpy as np
>>> import pywt
Expand Down
2 changes: 0 additions & 2 deletions doc/source/ref/signal-extension-modes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ computations can be performed with the `periodization`_ mode:
**Example:**

.. try_examples::
:button_text: Try it in your browser!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@agriyakhetarpal on this page the buttons disappeared. Maybe something went wrong here, could you check please?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's quite strange. I'm able to see the two buttons on https://pywavelets.readthedocs.io/en/latest/ref/signal-extension-modes.html, which is mapped to this file, and I verified that this file locally also contains two buttons. Could you please try with a fresh browser instance, or reload this page with caches disabled (Ctrl+Shift+R), perhaps?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, wrong page. I was showing this to someone else during a meeting, and we were looking at Usage Examples. I thought we had buttons there? It has a modes pages too: https://pywavelets.readthedocs.io/en/latest/regression/modes.html

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, the pages under the "Usage Examples" section need work to get them working at this time; just the API reference has been implemented. We shall need something like MyST-NB and then convert everything to notebooks in order for them to run with the NotebookLite directive. I reckon that Jupytext notebooks will be better than converting to IPyNB. I can get started on this soon if you would want me to do so? We had previously left these for a later time, now sounds like a good time to pick it up.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I misremembered then - that's what I get for doing things during a meeting on a Friday night.

No need to do it now if MyST-NB isn't ready yet (I'm aware of the work in SciPy on it), but once it's unblocked then yes it would be good to do it.

I reckon that Jupytext notebooks will be better than converting to IPyNB.

Oh yes, definitely some .md format and no .ipynb.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I misremembered then - that's what I get for doing things during a meeting on a Friday night.

No worries! 😄

No need to do it now if MyST-NB isn't ready yet (I'm aware of the work in SciPy on it), but once it's unblocked then yes it would be good to do it.

Oh yes, definitely some .md format and no .ipynb.

It's ready, actually, it is just SciPy that hits some edge cases because of its custom MathJax, and we managed to find a suitable solution quite recently. The rest of the work there can now be resumed, so nothing remains blocked. I think I will consider that, plus the relatively smaller size of PyWavelets, as my sign and start the work, after which all pages under the PyWavelets documentation will be embellished with interactivity.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds great, thanks Agriya.


>>> import pywt
>>> print(pywt.Modes.modes)
Expand All @@ -106,7 +105,6 @@ Notice that you can use any of the following ways of passing wavelet and mode
parameters:

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

>>> import pywt
>>> (a, d) = pywt.dwt([1,2,3,4,5,6], 'db2', 'smooth')
Expand Down
9 changes: 0 additions & 9 deletions doc/source/ref/wavelets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ Custom discrete wavelets are also supported through the
**Example:**

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

>>> import pywt
>>> wavelet = pywt.Wavelet('db1')
Expand Down Expand Up @@ -130,7 +129,6 @@ Custom discrete wavelets are also supported through the
**Example:**

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

>>> def format_array(arr):
... return "[%s]" % ", ".join(["%.14f" % x for x in arr])
Expand Down Expand Up @@ -174,7 +172,6 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``
**Example:**

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

>>> import pywt
>>> wavelet = pywt.Wavelet('db2')
Expand All @@ -190,7 +187,6 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``
**Example:**

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

>>> import pywt
>>> wavelet = pywt.Wavelet('bior3.5')
Expand Down Expand Up @@ -244,7 +240,6 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.
**Example:**

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

>>> import pywt, math
>>> c = math.sqrt(2)/2
Expand Down Expand Up @@ -279,7 +274,6 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.
**Example:**

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

>>> import pywt
>>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand Down Expand Up @@ -335,7 +329,6 @@ from plain Python lists of filter coefficients and a *filter bank-like* object.
**Example:**

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

>>> import pywt
>>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand Down Expand Up @@ -366,7 +359,6 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``
**Example:**

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

>>> import pywt
>>> wavelet = pywt.ContinuousWavelet('gaus1')
Expand All @@ -384,7 +376,6 @@ Approximating wavelet functions - ``ContinuousWavelet.wavefun()``
**Example:**

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

>>> import pywt
>>> wavelet = pywt.DiscreteContinuousWavelet('db1')
Expand Down
2 changes: 1 addition & 1 deletion util/readthedocs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cython
docutils<0.18
jupyterlite-sphinx
jupyterlite-sphinx>=0.14.0
jupyterlite-pyodide-kernel
pydata-sphinx-theme
pytest
Expand Down
Loading