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

Rebuild dependencies as UMD modules #5

Closed
agjohnson opened this issue Mar 14, 2023 · 5 comments
Closed

Rebuild dependencies as UMD modules #5

agjohnson opened this issue Mar 14, 2023 · 5 comments

Comments

@agjohnson
Copy link
Contributor

Opening this here, but the changes are at the included libraries instead. Just a note here for now though.

The reason some of the modules are not exporting functions is because the current bundles are meant to be used directly by the browser (which is the default for Webpack).

We instead intend to use these as UMD modules instead, so will need to output two modules for each library -- one the default browser bundle for direct use, and a UMD module.
Webpack can output multiple builds fairly easily, so this isn't a huge change.

I'll try to put up an example first.

@humitos
Copy link
Member

humitos commented Mar 15, 2023

@agjohnson
Copy link
Contributor Author

Yup that's the option. The work here is to break up the webpack configuration more, and go from outputting a dev/prod set of bundles to a dev/prod set of bundles for each library type.

@agjohnson
Copy link
Contributor Author

Example is here: readthedocs/doc-diff#9

On second thought, it's not necessary to split up most of our modules any more than they are. We likely just want to switch all of them to UMD instead. Also @humitos you do not need the other options you noted on the call.

The EA client sticks out, I think they are using the global/window variable (window.ethicalads).

@humitos
Copy link
Member

humitos commented Mar 27, 2023

We only need to polish the work we already done for EthicalAds and doc-diff only.

sphinx-hoverxref is being completely re-written using a different tooltips backend (tippy.js, which uses popper.js behind the scenes) and the js file from readthedocs-sphinx-search that uses the APIv3 was copied and included into this repository because I ended up required too many modifications.

Besides, I don't think it makes sense to continue supporting/maintaining these Sphinx extensions anymore. We should focus on doctool agnostic solutions we are creating and reduce the overhead that the fact of being an extension involves.

@humitos
Copy link
Member

humitos commented Apr 27, 2023

I'm going to close this because I've just included docdiff into this client in #63 and we have an issue for ethical ads at #6

@humitos humitos closed this as completed Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants