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

Set up a doc formatter #182

Open agoscinski opened 1 year ago

agoscinski commented 1 year ago

From discussion in PR #179: We have a doc linter, but no formatter for the doc rst files (like black for code) . But all existing formatter are not so perfect for our purpose and need a bit more tuning or/and some fixes.

docstrfmt:

  1. does not recognize citation and citation-reference sphinx nodes (this is a bug of rstfmt)
  2. it is quite aggressive (creates smaller case reference)

For 1. we need to open an issue at the respective repo. For 2. we need to figure how to config it