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

Add rst-lint doc syntax check #598

Open
simondeziel opened this issue Jul 15, 2024 · 0 comments
Open

Add rst-lint doc syntax check #598

simondeziel opened this issue Jul 15, 2024 · 0 comments

Comments

@simondeziel
Copy link
Member

ATM, rst-lint turn up many errors in our RST doc:

# rst-lint doc/source/ | cut -d " " -f 1,3- | sort -u
ERROR Unknown directive type "autoclass".
ERROR Unknown directive type "currentmodule".
ERROR Unknown directive type "py:currentmodule".
ERROR Unknown directive type "toctree".
ERROR Unknown interpreted text role "attr".
ERROR Unknown interpreted text role "class".
ERROR Unknown interpreted text role "doc".
ERROR Unknown interpreted text role "func".
ERROR Unknown interpreted text role "py:class".
ERROR Unknown interpreted text role "ref".

Ideally, running tox -e lint should install rst-lint (and its pygments dep) and lint all .rst file there is.

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

No branches or pull requests

1 participant