Skip to content

Add rst-lint doc syntax check #598

@simondeziel

Description

@simondeziel

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions