Skip to content

Documentation #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thomasaarholt opened this issue Mar 19, 2020 · 4 comments
Open

Documentation #208

thomasaarholt opened this issue Mar 19, 2020 · 4 comments

Comments

@thomasaarholt
Copy link
Contributor

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?

@martinRenou
Copy link
Member

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 :)

@thomasaarholt
Copy link
Contributor Author

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

@martinRenou
Copy link
Member

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

@ianhi
Copy link
Collaborator

ianhi commented Mar 26, 2022

@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?

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

No branches or pull requests

3 participants