RFC: Formatter tool for RST files

[al42and]

docstrfmt and rstfmt can reformat the RST files to make them uniform. This should not affect the rendered result, but should make the source easier to edit and read as a source (uniform line wrapping, indentation, etc).

Since this will generate a large diff, I suggest doing it after the workshop so it does not interfere with any editing activity.

Opening the issue to gauge the interest for this. Please comment if you want to see it implemented or have any opposition to it.

[stepas-toliautas]

On one hand, uniformity would be nice. On the other hand, some other ENCCS lessons tend to mix ReST and Markdown files (because Sphinx-lesson variant allows that); is it possible to treat both adequately, or Markdown files will then be left unedited?

[al42and]

The suggested tools are ReST-only, so they won't touch Markdown. Perhaps there is a single tool to handle both, but I am not aware of such. There are Markdown-specific tols (e.g., https://prettier.io/ -- no endorsement, just a random example).

But I think uniformity among RST files and non-uniformity among MD files is better than non-uniformity everywhere :)