Skip to content

build: UI docs and add plugin_builder.py#630

Merged
jnumainville merged 10 commits intodeephaven:mainfrom
jnumainville:627_ui_docs
Jul 22, 2024
Merged

build: UI docs and add plugin_builder.py#630
jnumainville merged 10 commits intodeephaven:mainfrom
jnumainville:627_ui_docs

Conversation

@jnumainville
Copy link
Copy Markdown
Collaborator

Fixes #627

Also adds a new tool plugin_builder.py that can be used to make some tasks like installing and developing plugins easier. The basic principle is you can either target specific plugins or target all plugins, depending on the command(s). This is a basic version and we can add on capabilities. Maybe unit tests or something that emulates editable installs for example. Specifically in this case, python tools/plugin_builder.py --docs ui can help test (although the requirements need to be installed first still).

Comment thread README.md Outdated
Comment thread sphinx_ext/make_docs_utilities.py Outdated
Comment thread sphinx_ext/make_docs_utilities.py Outdated
Comment thread tools/plugin_builder.py
Comment thread tools/plugin_builder.py Outdated
@jnumainville jnumainville requested a review from mofojed July 18, 2024 20:33
@jnumainville
Copy link
Copy Markdown
Collaborator Author

jnumainville commented Jul 19, 2024

@mofojed one thing I'm struggling with is the fact that we still have the plotly plugin around. It conflicts with the plotly-express plugin, which is not great when the default behavior is to install all plugins, including both of those. I played around with some sort of deprecation object, but it would make some of the implementation uglier for a package we won't be developing anymore anyways. Thoughts? A warning in the readme? Deleting the plugin? Moving it to a deprecated folder within plugins?

@mofojed
Copy link
Copy Markdown
Member

mofojed commented Jul 22, 2024

Keep a README to notify of deprecation, delete the rest of the plugin.

@jnumainville jnumainville merged commit 7281eec into deephaven:main Jul 22, 2024
jnumainville added a commit that referenced this pull request Jul 22, 2024
Removes plotly plugin as outlined in #630
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

Successfully merging this pull request may close these issues.

deephaven.ui docs auto-deploy

2 participants