-
Notifications
You must be signed in to change notification settings - Fork 21
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
Allow the use of a custom overrides.json
file for configuring JupyterLite at runtime
#225
Conversation
666cb36
to
ccabab1
Compare
c11a5e2
to
bf5e616
Compare
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/ ![]() |
Co-Authored-By: M Bussonnier <[email protected]>
779c5b2
to
b7e6bb6
Compare
Rebased on top of |
Description
This PR introduces a configuration option in
conf.py
calledjupyterlite_overrides
. This option modifies the command used to build JupyterLite internally withinjupyterlite-sphinx
to use a user-providedoverrides.json
file.Rationale
overrides.json
file in thedocs/
directory, similar toipycanvas
's documentation, which will automatically be picked up byjupyterlite-sphinx
(and thereby JupyterLite) when building the JupyterLite site.jupyterlite-sphinx
can benefit from the flexibility of using a custom override file with the docs, which is possible if one has access to the JupyterLite build command with ease.This option is already available via https://jupyterlite-sphinx.readthedocs.io/en/latest/configuration.html#additional-cli-arguments-for-jupyter-lite-build, which was established via Pass additional configuration options to the
jupyter lite build
command #169. Still, that approach has been directed mostly towards advanced users, and having this feature exposed through a configuration option similar to one for a build-time configuration file would make it easier to use and make it more visible with the rest of the options in the docs.Additional context
Please see jupyterlite/jupyterlite#385 (comment), which is where I got this idea. Some possible use cases for this can be: