Examples and tutorials in documentation, technical choices about scikit-matter HOT 4 CLOSED

Personally, I don't think examples should go in kernel-tutorials. KT should be purely pedagogic and serve a different purpose than use examples. I like the idea of leaving the outputs of the examples, but more-so making very "light" examples that contain 1-2 use cases. For example, the ones I have for feature selection use the sklearn data, so there's no loading of dataset, and plot very little. Thoughts?

from scikit-matter.

from scikit-matter.

Making a few notes after yesterday's meeting, we can have two kind of examples:

The first kind is inline "usage" examples, that live inside docstrings, and are tested as part of doctests.

The second kind is more advanced end-to-end or "workflow" examples, that can be either separate files with comments, included in sphinx documentation using literalinclude; or written inside sphinx rst sources. The advantages of the first solution is that we can add such examples to tests to ensure they don't bitrot and fall behind API changes. Such examples files could even be ran as part of documentation generation to create plots & other figures.

from scikit-matter.

Superseded by #90

from scikit-matter.