Luthaf / rascaline

Computing representations for atomistic machine learning
https://luthaf.fr/rascaline/
BSD 3-Clause "New" or "Revised" License
44 stars 13 forks source link

Render How-to guides using Sphinx galleries #127

Closed PicoCentauri closed 2 years ago

PicoCentauri commented 2 years ago

Render the user and developer how-tos using sphinx galleries. All examples use same dataset and hypers as the tutorials.

This change also makes the check_examples.py superflous since all examples will be run with sphinx.

The current solution for the Rust/C/C++ how-tos are so far not perfect but acceptable. The tab for theses examples are currently shown below the python example.

github-actions[bot] commented 2 years ago

The documentation for this PR is (or will soon be) available on readthedocs: https://rascaline--127.org.readthedocs.build/en/127/