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.

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

reSTLintBear: No support for sphinx #1716

Open
SanketDG opened this issue May 8, 2017 · 1 comment · May be fixed by #1718
Open

reSTLintBear: No support for sphinx #1716

SanketDG opened this issue May 8, 2017 · 1 comment · May be fixed by #1718

Comments

@SanketDG
Copy link
Member

SanketDG commented May 8, 2017

Sphinx has many custom directives and roles, for highlighting and cross referencing docs.

The restructuredtext_lint doesn't support any out of the box (it shouldn't)

So, there are lots of issues coala throws, see coala/documentation#438, regarding the unknown directive and roles

Although it gives support to register roles and directives, it doesn't make sense to register all of them and anything else sphinx adds in the future

Solution: Implement as a setting for sphinx to ignore all unknown directives and roles, through regex

@jayvdb
Copy link
Member

jayvdb commented May 9, 2017

What advantages are their for using reSTLintBear ? Does it show errors that RSTCheckBear doesnt show?

Can it do 'pure RST' checking better than RSTCheckBear?

If there is no good reason to have this bear, maybe we can just deprecate the reSTLintBear bear, and see if anyone complains?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

4 participants