-
Notifications
You must be signed in to change notification settings - Fork 251
Investigate if we need to add a linter for Read the Docs #428
Copy link
Copy link
Open
Labels
InfrastructureChanges related to project infrastructure ( CI/CD, deploy mechanism, etc. )Changes related to project infrastructure ( CI/CD, deploy mechanism, etc. )code qualityThis PR has to do with improving code readability/quality ( refactoring, etc. )This PR has to do with improving code readability/quality ( refactoring, etc. )
Description
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:
automoduletoctree
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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
InfrastructureChanges related to project infrastructure ( CI/CD, deploy mechanism, etc. )Changes related to project infrastructure ( CI/CD, deploy mechanism, etc. )code qualityThis PR has to do with improving code readability/quality ( refactoring, etc. )This PR has to do with improving code readability/quality ( refactoring, etc. )