fix rst style

rstcheck README.rst now passes.

requested review from @akarnad

@akarnad - I think this might fix the rstcheck issue.

added 1 commit

• 290febe5 - remove the reduction in rstcheck verbosity

Compare with previous version

It does fix it. The error message was not informative for me to debug this. It was pointing to an error in line 2 while this is not associated with line 2 at all.

It was a bit of (experienced) guess work to fix it. I agree the error message was not helpful.

Perhaps for that reason we should not include the rstcheck in the CI (and thus not in the pre-commit) at the moment: it is not essential that the rst files are formatted perfectly (as long as they display okay on gitlab, as it did; even without the 'error'), but it is essential that people can contribute to the repository without being rst experts.

This also reminds me that the information about the mpsd-software init step is out dated. Do we intend to keep this step in the workflow? in which case I will work on an MR for it if not we can remove it from the readme.

That information is in a comment, and thus not renderend when you look at the file (for example at https://gitlab.gwdg.de/mpsd-cs/mpsd-software-manager/-/blob/fix-readme-rstcheck/README.rst). So it can stay, I think. And when we add that feature, we can use it to update the docs.

I think it would be good to have that "init" step in the workflow: it will make it harder to set up a new instance, but will simplify the (safe) use afterwards.

approved this merge request

merged

mentioned in commit d23ee764