[Question]: Uninformative error when running on GH Actions

[adam2392]

To Dos

• I already searched with my favorite search engine "How to do X with rstcheck".

• I already read and followed the README and didn't find an answer.

• I have checked the issues and think that this is not a duplicate.

• I added a very descriptive title to this issue.

Description

In my GH actions workflow, I use rstcheck as part of pre-commit.

I get the following uninformative error:

doc/use.rst:10: (SEVERE/4) Problems with "include" directive path:
Error! Issues detected.

I have no ability to debug this because there is no verbosity option. I was wondering is there any tips here? It is referring to this file:

https://github.com/neurodata/scikit-tree/blob/main/doc/use.rst

Here is my pre-commit file: https://github.com/neurodata/scikit-tree/blob/main/.pre-commit-config.yaml

Operating System

Linux

Operating System Details

Ubuntu

Python Version

3.11

rstcheck Version

6.2

[Cielquan]

Rstcheck internally runs docutils and just parses docutil's returned errors. I guess that your error (from docutils) is split onto multiple lines, but rstcheck only takes the first line, I think. This could be the root cause.

I took a look at your file. The error points on the include directive, so only one line in the file can cause the issue. Then I looked at the file tree on the left and the issue seems pretty clear. The file auto_examples/index.rst does not exist, so rstcheck/docutils cannot find it and hence the error on SEVERE level.