doc8 icon indicating copy to clipboard operation
doc8 copied to clipboard

doc8 considers include directive paths starting with / to be invalid

Open SeanDS opened this issue 4 years ago • 0 comments

Include directives like this are valid Sphinx:

.. include:: /somefile.hrst

This is mentioned by the Sphinx developer here. The doc8 linter complains about the above definition though:

docs/source/myfile.rst:1: D000 Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: '/somefile.hrst'.

Sphinx includes the file just fine.

SeanDS avatar Apr 14 '21 11:04 SeanDS