executablebooks
Design and fix a spec and an interface for sphinx-related jupyter data
Jupyter-related data appears during several stages of the JB build:
- Jupyter cell and notebook metadata
- Sphinx AST nodes
- Nested jupyter-related DOM in the resulting HTML (IIUC this is html-specific, and there isn't a direct latex analog)
Developers, both working on the EBP stack, and on related packages would benefit from being able to rely on a specific format for most of these components. For example, developers of Jupyter extensions would be able to interpret the jupyter metadata, developers of sphinx extensions would be able to manipulate sphinx doctrees, or construct their own. Theme developers would be able to customize the appearance of jupyter-related content. As a more specific example, jupyter-sphinx has a more flexible way of embedding jupyter content than myst-nb, and could integrate well with the ebp stack if its DOM had the same classes, or if it used the same sphinx nodes.
As far as I understand, there's no documentation page for what the data should be at those points (I searched myst-nb, sphinx-book-theme, and jupyterbook.org).
I imagine the spec isn't yet cast in stone, but documenting it is also a good first step to reviewing it.
