diff options
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: |