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 the use of a custom overrides.json file for configuring JupyterLite at runtime #225

Conversation

agriyakhetarpal
Copy link
Member

Description

This PR introduces a configuration option in conf.py called jupyterlite_overrides. This option modifies the command used to build JupyterLite internally within jupyterlite-sphinx to use a user-provided overrides.json file.

Rationale

Additional context

Please see jupyterlite/jupyterlite#385 (comment), which is where I got this idea. Some possible use cases for this can be:

@agriyakhetarpal agriyakhetarpal added the enhancement New feature or request label Dec 12, 2024
@agriyakhetarpal agriyakhetarpal force-pushed the feat/allow-configuring-overrides-file branch 2 times, most recently from 666cb36 to ccabab1 Compare December 12, 2024 15:32
@agriyakhetarpal agriyakhetarpal marked this pull request as draft December 12, 2024 15:32
@agriyakhetarpal agriyakhetarpal force-pushed the feat/allow-configuring-overrides-file branch 2 times, most recently from c11a5e2 to bf5e616 Compare December 12, 2024 15:53
@agriyakhetarpal
Copy link
Member Author

I've (temporarily) pushed bf5e616, which enables the https://github.com/Quansight-Labs/jupyterlab-theme-christmas theme and a download button for notebooks within our documentation. It is working nicely and as expected, and the changes can be tried out in the PR preview: https://jupyterlite-sphinx--225.org.readthedocs.build/en/225/

A customised JupyterLite deployment within the the Sphinx documentation PR previews for jupyterlite-sphinx where JupyterLite can be seen running with the 'JupyterLab Christmas' theme. A download button is also available for the notebook.

@agriyakhetarpal agriyakhetarpal marked this pull request as ready for review December 12, 2024 16:51
dev-environment.yml Outdated Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
@agriyakhetarpal agriyakhetarpal force-pushed the feat/allow-configuring-overrides-file branch from 779c5b2 to b7e6bb6 Compare December 13, 2024 11:19
@agriyakhetarpal
Copy link
Member Author

Rebased on top of main and removed the Christmas theme I had added for experimentation. I can confirm that it continues to work with a local build. Thanks again for the review, @Carreau.

@agriyakhetarpal agriyakhetarpal merged commit 230ba7c into jupyterlite:main Dec 13, 2024
5 checks passed
@agriyakhetarpal agriyakhetarpal deleted the feat/allow-configuring-overrides-file branch December 13, 2024 11:26
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

Successfully merging this pull request may close these issues.

2 participants