PyWavelets / pywt

PyWavelets - Wavelet Transforms in Python
http://pywavelets.readthedocs.org
MIT License
1.97k stars 460 forks source link

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

Closed agriyakhetarpal closed 2 months ago

agriyakhetarpal commented 2 months ago

Description

This is a small PR because jupyterlite-sphinx has a new release (https://github.com/jupyterlite/jupyterlite-sphinx/issues/171) which simplifies some things here.

Addresses some issues found in #728 and is a bigger part of #706. I had committed this last month, now rebased on top of the latest changes.

Changes made

  1. I updated the minimum jupyterlite-sphinx version to 0.14.0 corresponding to the new release, and
  2. with that, I removed the :button_text: option from the .. try_examples:: directives everywhere in the source code, since the directive can now use the global configuration in conf.py.

Additional context

While the documentation is building alright right now, the upper pin on docutils restricts us to Sphinx v5.3.0, while the seemingly more stable v7.3.7 is available. Should we remove this pin? I removed it and built the docs again without issues, so, it doesn't seem to be needed. @rgommers, do we still need this pin or can we relax it? I can't find anything with a quick search suggestive of why this pin exists; if it makes sense, I am happy to do this in the same PR.