jupyterlab / hatch-jupyter-builder

A hatch plugin to help build Jupyter packages
https://hatch-jupyter-builder.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
39 stars 14 forks source link

Order of operations documentation request #113

Open paddymul opened 1 year ago

paddymul commented 1 year ago

Description

I have seen a lot of docs about "how to make a jupyterlab extension" and "how to make an ipywidget". Most of them use hatch-jupyter-builder in some form.

The configuration options are listed "just so", without an explanation of what the different options do.

I have some idea that when a package built with hatch-jupyter-builder is pip installed, there are some sequence of commands executed similar to jupyter labextension develop --overwrite . It would be helpful to list which exact commands are executed, so a user of hatch-jupyter-builder understand the individual steps and what is going wrong.

Expected behavior

Step by step explanation of what hatch-jupyter-builder does.