Skip to content

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

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

Open
gnikonorov opened this issue Dec 17, 2020 · 0 comments
Open

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

gnikonorov opened this issue Dec 17, 2020 · 0 comments
Labels
code quality This PR has to do with improving code readability/quality ( refactoring, etc. ) Infrastructure Changes related to project infrastructure ( CI/CD, deploy mechanism, etc. )

Comments

@gnikonorov
Copy link
Member

gnikonorov commented Dec 17, 2020

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

@gnikonorov gnikonorov added Infrastructure Changes related to project infrastructure ( CI/CD, deploy mechanism, etc. ) code quality This PR has to do with improving code readability/quality ( refactoring, etc. ) labels Dec 17, 2020
@gnikonorov gnikonorov assigned gnikonorov and unassigned gnikonorov Dec 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality This PR has to do with improving code readability/quality ( refactoring, etc. ) Infrastructure Changes related to project infrastructure ( CI/CD, deploy mechanism, etc. )
Projects
None yet
Development

No branches or pull requests

1 participant