ipyaladin icon indicating copy to clipboard operation
ipyaladin copied to clipboard

Write a documentation for the widget

Open ManonMarchand opened this issue 2 years ago • 3 comments

Before the V1, we should write a documentation

  • [ ] API
  • [ ] Examples
  • [ ] GUI

ManonMarchand avatar Jun 02 '23 08:06 ManonMarchand

Don't forget to explain the functions that need to update an existing instance of the widget ( see #61 )

ManonMarchand avatar Jun 02 '23 08:06 ManonMarchand

For future reference, we could embed the examples as jupyterlite notebooks with : https://xeus-python-kernel.readthedocs.io/en/latest/configuration.html#pip-packages and https://jupyterlite-sphinx.readthedocs.io/en/latest/

ManonMarchand avatar Aug 23 '23 09:08 ManonMarchand

Beautiful thebe extension to use jupyterlite in any webpage : https://executablebooks.github.io/thebe/

ManonMarchand avatar Aug 23 '23 10:08 ManonMarchand