Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow customising which JupyterLite apps are to be built #260

Open
agriyakhetarpal opened this issue Jan 22, 2025 · 1 comment
Open

Allow customising which JupyterLite apps are to be built #260

agriyakhetarpal opened this issue Jan 22, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@agriyakhetarpal
Copy link
Member

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 overriding --apps via jupyterlite_build_command_config, but that's limited to advanced users). There's another option, i.e., to use jupyter_lite_config.json to do this, but this file's purpose has not been explained to the user directly.

Proposed Solution

A jupyterlite_apps configuration option hooked into Sphinx which can take a list such as ["repl", "voici", "notebook"], and so on to pass to --apps, with a UserWarning (or a RuntimeError?) emitted if a jupyter_lite_config.json file exists + already has a ["LiteBuildConfig"]["apps"] key that collides with said configuration option.

Additional context

This would be helpful for those users who willingly want to customise which apps to build for size reasons, etc. without going through the jupyter_lite_config.json route.

@agriyakhetarpal agriyakhetarpal added the enhancement New feature or request label Jan 22, 2025
@jtpio
Copy link
Member

jtpio commented Jan 22, 2025

Thanks @agriyakhetarpal.

Linking to #114 as related.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants