Skip to content

Investigate if we need to add a linter for Read the Docs #428

Open
@gnikonorov

Description

@gnikonorov

Read the docs may or may not perform sufficient linting for us. The purpose of this card is to investigate our linting options and add a linter if needed

I did some research and found that we can still use rst-lint, but we need to allow the following two directives:

  • automodule
  • toctree

The above can be done via https://github.com/twolfson/restructuredtext-lint#sphinx. I'll try to make a PR for this in the next few days. It will involve a custom script for the docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    InfrastructureChanges related to project infrastructure ( CI/CD, deploy mechanism, etc. )code qualityThis PR has to do with improving code readability/quality ( refactoring, etc. )

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions