scikit-learn-contrib / scikit-matter

A collection of scikit-learn compatible utilities that implement methods born out of the materials science and chemistry communities
https://scikit-matter.readthedocs.io/en/v0.2.0/
BSD 3-Clause "New" or "Revised" License
70 stars 18 forks source link

Add linting and tests for docstring and documentation code #184

Closed PicoCentauri closed 1 year ago

PicoCentauri commented 1 year ago

As given in the title code example blocks are now linted with blackdoc and examples with outputs are tested with doctest. I also added a toggle button for easier copying of examples with the help of sphinx-toggleprompt.

Many of the examples of the docs had some minor issues which I corrected. Let me know if I did anything wrong.


:books: Documentation preview :books:: https://scikit-matter--184.org.readthedocs.build/en/184/