yamllint/docs/index.rst

yamllint documentation
======================

.. automodule:: yamllint

Screenshot
----------

.. image:: screenshot.png
   :alt: yamllint screenshot

.. note::

   The default output format is inspired by `eslint <http://eslint.org/>`_, a
   great linting tool for Javascript.

Table of contents
-----------------

.. toctree::
   :maxdepth: 2

   quickstart
   configuration
   rules
   disable_with_comments
   development
   text_editors
   integration
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			`yamllint documentation`
			`======================`

Doc: Update description 2016-02-01 16:03:25 -06:00			`.. automodule:: yamllint`
Doc: Enhance short description 2016-01-24 11:37:24 -06:00
Doc: Add a screenshot 2016-01-23 07:30:24 -06:00			`Screenshot`
			`----------`

			`.. image:: screenshot.png`
			`:alt: yamllint screenshot`

			`.. note::`

			The default output format is inspired by `eslint <http://eslint.org/>`_, a
			`great linting tool for Javascript.`

			`Table of contents`
			`-----------------`

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			`.. toctree::`
			`:maxdepth: 2`

			`quickstart`
			`configuration`
			`rules`
Allow disabling yamllint checks using comments Implement problem report disabling with comments in YAML source, for instance: # The following mapping contains the same key twice, # but I know what I'm doing: key: value 1 key: value 2 # yamllint disable-line rule:key-duplicates or: # yamllint disable rule:colons - Lorem : ipsum dolor : sit amet, consectetur : adipiscing elit # yamllint enable rule:colons Closes: #8 2016-06-26 13:07:40 -05:00			`disable_with_comments`
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`
			`text_editors`
Add documentation for pre-commit 2017-07-19 05:08:04 -05:00			`integration`