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

Auto-generate documentation for chplcheck lint rules #26208

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

jabraham17
Copy link
Member

@jabraham17 jabraham17 commented Nov 5, 2024

Adds documentation for chplcheck rules, auto-generated from the existing chplcheck rule defintions.

This PR makes the following changes:

  1. make docs will now build a rules.rst file which is included in the chplcheck documentation which lists all lint rules
    • This is enabled by the doc/util/chplcheck-docs.py, which is also available to users for their own custom rule files
    • Rules can also have examples, specified in tools/chplcheck/examples. These are included in the online docs and provide reasoning to users about why a lint rule exists
  2. The chplcheck langauge server will provides a link straight to rule documentation
    Screenshot 2024-11-04 at 4 08 44 PM

TODO: document doc/util/chplcheck-docs.py
TODO: make links more robust with version info
TODO: formatting of the rst
TODO: add more examples for rules and make sure those examples are run as tests
TODO: add settings info from #26190

Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
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

Successfully merging this pull request may close these issues.

1 participant