yamllint/docs/development.rst

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("example.yaml", yaml_config):
       print(p.desc, p.line, p.rule)

.. automodule:: yamllint.linter
   :members:
Doc: Generate documentation with Sphinx HTML documentation should be built with sphinx. This enables easy integration with Read The Docs [1]. It can also be generated manually by running: make -C docs html A man page can be generated by running: make -C docs man [1]: http://yamllint.readthedocs.org/ 2016-01-21 14:48:57 -06:00			`Development`
			`===========`

Doc: Document how to use the yamllint Python module 2016-01-22 10:22:04 -06:00			`yamllint provides both a script and a Python module. The latter can be used to`
docs: Add Python API usage example Fixes: #297 2020-08-25 13:10:32 -05:00			`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("example.yaml", yaml_config):`
			`print(p.desc, p.line, p.rule)`
Doc: Document how to use the yamllint Python module 2016-01-22 10:22:04 -06:00
Refactor project layout to import yamllint alone Currently importing yamllint recursively imports its submodules, which finally requires having pyyaml installed. This is a problem when you just want to import APP_VERSION from yamllint. For instance, setup.py imports yamllint to know the version, but doesn't know yet that pyyaml is to be installed, because it is stated in setup.py itself. To solve this, yamllint/__init__.py will only contain constants. The linting functions will be in yamllint/linter.py. 2016-01-24 10:48:20 -06:00			`.. automodule:: yamllint.linter`
Doc: Generate documentation with Sphinx HTML documentation should be built with sphinx. This enables easy integration with Read The Docs [1]. It can also be generated manually by running: make -C docs html A man page can be generated by running: make -C docs man [1]: http://yamllint.readthedocs.org/ 2016-01-21 14:48:57 -06:00			`:members:`