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:

.. autoclass:: yamllint.errors.LintProblem
   :members:

.. automodule:: yamllint
   :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/ 9 years ago			`Development`
			`===========`

Doc: Document how to use the yamllint Python module 9 years ago			`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:`

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/ 9 years ago			`.. automodule:: yamllint`
			`:members:`