search

jupyter / jupyter-sphinx

Sphinx extension for rendering of Jupyter interactive widgets.
https://jupyter-sphinx.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
188 stars 65 forks source link

Introduce new jupyter-download syntax, fixes #182 #207

Closed basnijholt closed 2 years ago

basnijholt commented 2 years ago

Since Sphinx 4.0.0 using : inside of a role/directive does not work, see #182. Therefore, we add - as a separator to get, jupyter-download-notebook, jupyter-download-nb, and jupyter-download-script. We leave the : syntax for backward compatibility reasons.

akhmerov commented 2 years ago

Overall this looks good, thank you for figuring out the origin of this problem! Please add a short update to the 0.4.0 changelog. I think we should also add a deprecation warning to the old roles and promise to eliminate the : syntax in 0.5.0.

basnijholt commented 2 years ago

I just added a changelog entry and a DeprecationWarning.