Skip to content
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

Split the Elements notebooks into pieces #879

Closed
jlstevens opened this issue Sep 21, 2016 · 5 comments
Closed

Split the Elements notebooks into pieces #879

jlstevens opened this issue Sep 21, 2016 · 5 comments
Assignees
Labels
type: docs Related to the documentation and examples type: feature A major new feature
Milestone

Comments

@jlstevens
Copy link
Contributor

This issue summarises a discussion I've have with @jbednar and @philippjfr

We would like to get rid of the existing elements notebooks and have an Elements section in the website sidebar which expands with a list of all the elements. At the top of this list would be a navigation page showing a grid of thumbnails for all the different backends.

Each element notebook would then show how that element is constructed across backends. This proposal has the following advantages:

  1. Makes it easier to add new elements (no need to update the whole notebook)
  2. Makes it easier to test elements (identify which element went wrong given a failure)
  3. Makes it easier to update those notebook tests
  4. Make it easier to compare elements across backends.

To generate thumbnails, we would use a notebook archive. These thumbnails would be shown in a grid and there could be buttons to toggle the thumbnails between backends (unsupported elements would be greyed out appropriately).

This could all be organized in doc in an Elements subdirectory. For instance, I can imagine the following file paths:

doc/Elements/Index.html
doc/Elements/Image.ipynb
doc/Elements/thumbnails/mpl/Image.png
doc/Elements/thumbnails/bokeh/Image.png
@jlstevens jlstevens added type: feature A major new feature type: docs Related to the documentation and examples labels Sep 21, 2016
@jbednar
Copy link
Member

jbednar commented Sep 21, 2016

Thanks for the summary!

@jlstevens jlstevens added this to the v1.7.1 milestone Apr 27, 2017
@philippjfr
Copy link
Member

I still need to do Surface and Trisurface otherwise this is ready.

@jlstevens
Copy link
Contributor Author

I think we also decided to do something similar for the container notebooks in the end.

@philippjfr
Copy link
Member

Added Surface and Trisurface today, closing.

Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: docs Related to the documentation and examples type: feature A major new feature
Projects
None yet
Development

No branches or pull requests

3 participants