NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2024-11-26 01:20:15 -06:00
Code Issues Packages Projects Releases Wiki Activity
d41b64aa97
yamllint/docs/rules.rst

116 lines
1.8 KiB
ReStructuredText
Raw Normal View History

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
Rules
=====
When linting a document with yamllint, a series of rules (such as
``line-length``, ``trailing-spaces``, etc.) are checked against.
A :doc:`configuration file <configuration>` can be used to enable or disable
these rules, to set their level (*error* or *warning*), but also to tweak their
options.
This page describes the rules and their options.
.. contents:: List of rules
:local:
:depth: 1
braces
------
.. automodule:: yamllint.rules.braces
brackets
--------
.. automodule:: yamllint.rules.brackets
colons
------
.. automodule:: yamllint.rules.colons
commas
------
.. automodule:: yamllint.rules.commas
comments
--------
.. automodule:: yamllint.rules.comments
comments-indentation
--------------------
.. automodule:: yamllint.rules.comments_indentation
document-end
------------
.. automodule:: yamllint.rules.document_end
document-start
--------------
.. automodule:: yamllint.rules.document_start
empty-lines
-----------
.. automodule:: yamllint.rules.empty_lines
Add rule: empty-values, to forbid implicit nulls only in block mappings for now
2017-10-31 15:32:12 -05:00
empty-values
------------
.. automodule:: yamllint.rules.empty_values
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
hyphens
-------
.. automodule:: yamllint.rules.hyphens
indentation
-----------
.. automodule:: yamllint.rules.indentation
Rules: Add the 'key-duplicates' rule
2016-02-01 14:36:44 -06:00
key-duplicates
--------------
.. automodule:: yamllint.rules.key_duplicates
New rule key-ordering closes #67
2017-09-19 02:54:45 -05:00
key-ordering
--------------
.. automodule:: yamllint.rules.key_ordering
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
line-length
-----------
.. automodule:: yamllint.rules.line_length
new-line-at-end-of-file
-----------------------
.. automodule:: yamllint.rules.new_line_at_end_of_file
new-lines
---------
.. automodule:: yamllint.rules.new_lines
Feature: checking octal numbers
2017-12-06 08:15:24 -06:00
octal-values
------------
.. automodule:: yamllint.rules.octal_values
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
trailing-spaces
---------------
.. automodule:: yamllint.rules.trailing_spaces
docs(rules): Fix missing truthy rule in index
2016-10-01 02:30:16 -05:00
truthy
---------------
.. automodule:: yamllint.rules.truthy
Reference in New Issue Copy Permalink