jupyterlite-sphinx
jupyterlite-sphinx copied to clipboard
jupyterlite
Sphinx extension using JupyterLite to render Notebooks
## Description The iframes sources are defined as `https://whatever.readthedocs.io/lite/replite/...`, "lite" being the directory in which JupyterLite is built. This causes an issue when the iframe is embedded in a docs...
### Problem There is already a section in the docs to deploy JupyterLite to ReadTheDocs: https://jupyterlite.readthedocs.io/en/latest/deploying.html#readthedocs However the config in the main repo might feel a bit intimidating and a...
## Description The function `_process_docstring_examples` used `app.env.doc2path`, which now needs paths instead of strings, since Sphinx 9 will drop support for representing paths as strings, which was raising warnings for...
The CI doc builds for SciPy recently started failing: https://github.com/scipy/scipy/issues/21323 The error message suggests a problem with `jupyterlite_sphinx`. It looks like an exception is being generated when used with the...
## Description I am integrating jupyterlite-sphinx into mesa-geo [readthedocs](https://github.com/projectmesa/mesa-geo) but my build keeps failing with the following error on in read the docs (no issues if doing jupyter lite build...
## Description According to the JavaScript (ECMAScript) standard for regular expressions, forward slashes (`/`) need to be escaped properly through backslashes (`\`), which means that the current instructions in the...
### Problem `jupyterlite-sphinx` does not yet support Jupytext (Markdown) notebooks in its directives. Markdown notebooks are a wonderful solution to existing notebook tooling designed for IPyNB notebooks, which are hard...
### Description This PR allows the `jupyterlite_contents` configuration option to pick up contents from `app.srcdir`, i.e., to add notebooks outside `docs/` or `docs/source/`. For example, it can be used to...
When the top build command is run outside of Sphinx' `srcdir` (which is the case when buliding from Jupyterbook for instance) the following happens: 1. [`jupyterlite_contents` path are expanded with...
- See https://github.com/jupyterlab/jupyterlab/pull/13837 and https://github.com/jupyterlite/jupyterlite/pull/1570 - Documented in https://github.com/jupyterlite/jupyterlite/pull/1573 - See also https://github.com/jupyterlite/jupyterlite/pull/525 This will require relaxing the `jupyterlite-core` requirement to be relaxed when 0.6.0 stable is released upstream.
Metadata
Owner
Metadata
Sphinx extension using JupyterLite to render Notebooks