ipympl Documentation

There is now a lot of really nice functionality in ipympl, but it is hard to find. The in-depth documentation at ipywidgets is a really good supporting resource, but some aspects (like display(fig.canvas) and not display(fig) need to be clearly expressed.

I'm happy to write documentation for ipympl, but to do that we need some sort of framework to write in. Can someone help with this?

Mar 19 '20 11:03 thomasaarholt

I totally agree and I can definitely help with this. I would suggest taking another project as starting point, like ipyleaflet, which uses sphinx and readthedocs.

Just copy the docs directory and paste it in here. Then remove almost everything so that only what's necessary remains :)

Mar 19 '20 12:03 martinRenou

I'll make a PR of this, with what I can manage + a bunch of questions/topics that need some clarification.

Mar 19 '20 18:03 thomasaarholt

Thanks a lot for this!

If you want to build the documentation, run make html from the docs directory. You would need sphinx installed:

conda install -c conda-forge sphinx shpinx_rtd_theme

Mar 20 '20 07:03 martinRenou

@thomasaarholt after #434 we now have docs (hopefully soon to be live on the web). Can we close this, or are there some things you would like to add?

Mar 26 '22 03:03 ianhi