Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc8 considers include directive paths starting with / to be invalid #54

Open
SeanDS opened this issue Apr 14, 2021 · 0 comments
Open

doc8 considers include directive paths starting with / to be invalid #54

SeanDS opened this issue Apr 14, 2021 · 0 comments

Comments

@SeanDS
Copy link

SeanDS commented Apr 14, 2021

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@SeanDS