Unexpected indentations in movement.validators.files.ValidVIATracksCSV docs

[lochhh]

Describe the bug
In #219 docs build succeeds with the following warnings (and errors):

movement\movement\validators\files.py:docstring of movement.validators.files.ValidVIATracksCSV.csv_file_contains_tracked_bboxes:6: ERROR: Unexpected indentation.
movement\movement\validators\files.py:docstring of movement.validators.files.ValidVIATracksCSV.csv_file_contains_tracked_bboxes:7: WARNING: Block quote ends without a blank line; unexpected unindent.
movement\movement\validators\files.py:docstring of movement.validators.files.ValidVIATracksCSV.csv_file_contains_valid_frame_numbers:5: ERROR: Unexpected indentation.
movement\movement\validators\files.py:docstring of movement.validators.files.ValidVIATracksCSV.csv_file_contains_valid_frame_numbers:6: WARNING: Block quote ends without a blank line; unexpected unindent.

While this has since been rectified in #245, the documentation is not rendering as intended (see example screenshot below).

Screenshots

[niksirbi]

Thanks for catching (and fixing) this!

[sfmig]

thanks @lochhh!

I was confused about this actually... do you know why the doc building succeeds even if there are errors? Should we change this behaviour (is it possible)?

[lochhh]

thanks @lochhh!

I was confused about this actually... do you know why the doc building succeeds even if there are errors? Should we change this behaviour (is it possible)?

Here it says build succeeded with warnings - only when we look into the warnings, we see that there are "errors". If we think warnings are overly permissive, there is the --fail-on-warning flag to treat warnings as errors, causing build to fail.

[sfmig]

I found a relevant open issue in sphinx-docs here.

It feels a bit annoying...