Issue with current documentation:
This is a short follow-up issue stemmed off from gh-26745 (review) and gh-26745 (comment) – once said PR is merged, the NumPy documentation for contributors and core developers should mention how to enable interactive examples with jupyterlite-sphinx. This issue aims to track that process, with the information to be added pertaining to:
Additional context
cc: @melissawm, @rgommers, @steppi
Idea or request for content:
My idea is that the most appropriate place(s) to add documentation related to this should be in these pages and cross-linked with each other, based on the last point above:
- https://github.com/numpy/numpy/blob/main/doc/RELEASE_WALKTHROUGH.rst, and
- https://numpy.org/devdocs/dev/howto-docs.html#docstring-intro, and
- perhaps a "Pyodide" section nearby https://numpy.org/devdocs/dev/howto_build_docs.html#instructions?
Additionally, some suggestions from @melissawm are as follows:
I would either link or get inspiration from scipy.github.io/devdocs/dev/core-dev/index.html#wrapping-up (for the release guide) and the "Interactive documentation" section on scipy.github.io/devdocs/dev/contributor/rendering_documentation.html#rendering-documentation-locally-with-sphinx
With some guidelines set on the interactive documentation goal and once gh-26745 gets merged, we could soon start looking at enabling interactivity in the "User Guide" pages and potentially for https://numpy.org/numpy-tutorials/ in the future. IMO, some of these points I have mentioned above could be better placed in part in a SPEC document rather than completely in the NumPy documentation, though.
Issue with current documentation:
This is a short follow-up issue stemmed off from gh-26745 (review) and gh-26745 (comment) – once said PR is merged, the NumPy documentation for contributors and core developers should mention how to enable interactive examples with
jupyterlite-sphinx. This issue aims to track that process, with the information to be added pertaining to:>>> import numpy as npstubs everywhere #26814jupyterlite-sphinx, links to its documentation, and instructions on how to enable/disable interactive examples on certain sections for the development version or released versions of the documentation via suitable modifications in thetry_examples.jsonfile for features or API sections that are not available with in-tree Pyodide wheels; andAdditional context
cc: @melissawm, @rgommers, @steppi
Idea or request for content:
My idea is that the most appropriate place(s) to add documentation related to this should be in these pages and cross-linked with each other, based on the last point above:
Additionally, some suggestions from @melissawm are as follows:
I would either link or get inspiration from scipy.github.io/devdocs/dev/core-dev/index.html#wrapping-up (for the release guide) and the "Interactive documentation" section on scipy.github.io/devdocs/dev/contributor/rendering_documentation.html#rendering-documentation-locally-with-sphinx
With some guidelines set on the interactive documentation goal and once gh-26745 gets merged, we could soon start looking at enabling interactivity in the "User Guide" pages and potentially for https://numpy.org/numpy-tutorials/ in the future. IMO, some of these points I have mentioned above could be better placed in part in a SPEC document rather than completely in the NumPy documentation, though.