diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 00:38:50 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 00:38:50 +0000 |
commit | 09e7b47bad7e7310a6f52bdc20e9a9f251e79769 (patch) | |
tree | c93d189c1318902b8f1e5333d7ee34a1e9db9a34 /docs/development.rst | |
parent | Initial commit. (diff) | |
download | yamllint-09e7b47bad7e7310a6f52bdc20e9a9f251e79769.tar.xz yamllint-09e7b47bad7e7310a6f52bdc20e9a9f251e79769.zip |
Adding upstream version 1.33.0.upstream/1.33.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | docs/development.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/development.rst b/docs/development.rst new file mode 100644 index 0000000..b179de2 --- /dev/null +++ b/docs/development.rst @@ -0,0 +1,18 @@ +Development +=========== + +yamllint provides both a script and a Python module. The latter can be used to +write your own linting tools. + +Basic example of running the linter from Python: + +.. code-block:: python + + import yamllint + + yaml_config = yamllint.config.YamlLintConfig("extends: default") + for p in yamllint.linter.run(open("example.yaml", "r"), yaml_config): + print(p.desc, p.line, p.rule) + +.. automodule:: yamllint.linter + :members: |