Documetnation3

[12rambau]

Rational

It's been several years now that i've been using the ipyvuetify to build succesfull dashboard and I must confess that with the release of Solara I was delighted to see I can now deploy them outside of a jupyter server context freeign from lots of issues I faced in the past.

The one major drawback that I faced in this timeframe is the difficulty to train pure python data scientist, or pure python developer into using this lib. The main blocker for them was the absence of documentation of components in Python. To use the lib you need to first understand the vue scripting mechanism and then understand the way ipyvuetify wire everything together. It's too long of a process for most. So I decided to embark myself again on this crusade of building a full documentation for the lib. By doing so I realized that reproducing all the exemple from the original doc is also challenging even for a seasoned user like myself making it even more relevant (I think).

The pre-build of the documentation can be found here: https://ipyvuetify-docs-test.readthedocs.io/en/latest/

I tried 2 years ago to perfomr the same exercice and it never went through as our presence in the open source space was out of sync, this time I will propose a complete thing even if sometime I go a bit sideway from what you would have coded yourself

Modifications

WIP

TODO

• finish documenting every component individually
• review all the component API descriptions and fill the missing ones
• reorganized the component documentation sections (they are currently in alphabitcal order)
• fill the intermediary pages with expalinations (specifically the component.rst one)
• move all the exemple code in dedicated files for linting (I keep them where they are now to provide as much context as possible to copilot when he tries to guess)
• add a disclaimerr banner
• review as much example as possible

linked issues

Fix #268
Fix #180
Fix #13