Doc: Document how to use the yamllint Python module

2016-01-22 17:22:04 +01:00
parent 6e9de02eac
commit 237db5aeef
2 changed files with 11 additions and 0 deletions
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -1,5 +1,11 @@
 Development
 ===========

+yamllint provides both a script and a Python module. The latter can be used to
+write your own linting tools:
+
+.. autoclass:: yamllint.errors.LintProblem
+   :members:
+
 .. automodule:: yamllint
   :members: