jupyterlite-sphinx
jupyterlite-sphinx copied to clipboard
Sphinx extension using JupyterLite to render Notebooks
## Description On pages where API reference examples to be made interactive are widespread and multiple ones exist, there are a lot of redundant error messages in the console (as...
### Problem `jupyterlite-sphinx` is currently not able to process reST/MyST references to their URLs, like Sphinx/napoleon or Numpydoc can. This leads to class names, table of contents links, etc. getting...
This issue aims to track the problem of `jupyterlite-sphinx`'s dependencies also being available for JupyterLite when building – which have the potential to mislead users, such as warnings in downstream...
## Description Post the merge of numpy/numpy#26745, I found a broken example in the NumPy docs: https://numpy.org/devdocs/reference/generated/numpy.percentile.html ## Reproduce 1. Go to https://numpy.org/devdocs/reference/generated/numpy.percentile.html 2. Scroll down to the "Examples" section...
### Problem It is currently not possible to customise which of the apps JupyterLite has to build as a result of `jupyterlite-sphinx` embedding its build command (it is possible by...
### Problem From https://github.com/jupyterlite/jupyterlite-sphinx/pull/251#issuecomment-2587500462: add more reST-based directives that have easy conversion from reST to Markdown for the interactive notebooks generated by the `TryExamples` directive. ### Proposed Solution Similar to...
### Problem From https://github.com/jupyterlite/jupyterlite-sphinx/pull/251#issuecomment-2587500462: add more admonitions besides regular alerts based on the PST styles and colour schemes: https://pydata-sphinx-theme.readthedocs.io/en/stable/examples/kitchen-sink/admonitions.html#admonitions ### Proposed Solution Similar to `div class='alert alert-warning'>\` ### Additional context
### Problem Users need to install both `jupyterlite-xeus` and `jupyterlite-pyodide-kernel` separately with `jupyterlite-sphinx` as a part of their docs requirements/lockfiles or with their `[docs]` (or sometimes `[doc]`) optional dependencies. ###...
Currently, we generate notebooks for the `TryExamples` directive, and the `JupyterLite`, `NotebookLite`, and `Voici` directives can take a path to a notebook. While we can disable the [JupyterLite source maps](https://jupyterlite.readthedocs.io/en/stable/reference/api/py/jupyterlite-core.html#jupyterlite_core.config.LiteBuildConfig.no_sourcemaps)...
This PR intends to close #226, and is currently a work in progress. I shall update the description soon once I have the buttons working the same as they are...