Manim: Example thumbnails in docs

Created on 11 Aug 2020  路  2Comments  路  Source: ManimCommunity/manim

Ideas for the documentation page:

The way I learned manim, was with lots of examples.
As this might be very useful for others as well, it would be lovely when the documentation of the classes and methods have easily accessible links to examples.
I looked into the documentation of matplotlib, and there they have under each explanation thumbnails of examples, where this or that class/method is used.
See for example here:
https://matplotlib.org/api/_as_gen/matplotlib.axes.Axes.boxplot.html#matplotlib.axes.Axes.boxplot
When you click on one of the example thumbnails, you will be directed to the corresponding example with code and the output image.

In the case of manim, we can have this as well.
What do you think about this?

Most helpful comment

Yes, I like what matplotlib does with examples in general. One thing I don't like is that they have _so many_ examples that some of them are quite a bit better (more illustrative, clearer, better explained) than others. I presume that's just a byproduct of being such a huge library.

In any case, I'm in favor of this. HOWEVER, I suggest we start with something basic, and iterate from there. The system that matplotlib uses makes sense for them because they have dozens (hundreds?) of examples. I don't think it's worth to build this whole system for us at this stage.

Let's just focus on having a single examples page in the documentation with links to a few examples. When we have that, we can talk about how to connect it to the rest of the documentation and so on.

All 2 comments

Yes, I like what matplotlib does with examples in general. One thing I don't like is that they have _so many_ examples that some of them are quite a bit better (more illustrative, clearer, better explained) than others. I presume that's just a byproduct of being such a huge library.

In any case, I'm in favor of this. HOWEVER, I suggest we start with something basic, and iterate from there. The system that matplotlib uses makes sense for them because they have dozens (hundreds?) of examples. I don't think it's worth to build this whole system for us at this stage.

Let's just focus on having a single examples page in the documentation with links to a few examples. When we have that, we can talk about how to connect it to the rest of the documentation and so on.

@kolibril13 you should look into this https://sphinx-gallery.github.io/stable/index.html for building the examples

Was this page helpful?
0 / 5 - 0 ratings

Related issues

qo4on picture qo4on  路  6Comments

dakyion picture dakyion  路  8Comments

leotrs picture leotrs  路  5Comments

huguesdevimeux picture huguesdevimeux  路  5Comments

nilaybhatia picture nilaybhatia  路  6Comments