Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
792bdf99b4 | ||
|
|
92798dbda9 | ||
|
|
e3ebea6033 | ||
|
|
7983c66093 | ||
|
|
fee72d484e |
@@ -15,7 +15,7 @@ A linter for YAML files.
|
||||
:target: http://yamllint.readthedocs.org/en/latest/?badge=latest
|
||||
:alt: Documentation status
|
||||
|
||||
Compatible with Python 2 & 3.
|
||||
Written in Python (compatible with Python 2 & 3).
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
@@ -25,6 +25,12 @@ http://yamllint.readthedocs.org/
|
||||
Short overview
|
||||
--------------
|
||||
|
||||
Screenshot
|
||||
^^^^^^^^^^
|
||||
|
||||
.. image:: docs/screenshot.png
|
||||
:alt: yamllint screenshot
|
||||
|
||||
Installation
|
||||
^^^^^^^^^^^^
|
||||
|
||||
|
||||
@@ -3,6 +3,20 @@ yamllint documentation
|
||||
|
||||
A linter for YAML files.
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ You can also lint all YAML files in a whole directory:
|
||||
|
||||
yamllint .
|
||||
|
||||
The output will look like (colors are not displayed here [#colored-output]_):
|
||||
The output will look like (colors are not displayed here):
|
||||
|
||||
::
|
||||
|
||||
@@ -70,8 +70,3 @@ option:
|
||||
|
||||
If you have a ``.yamllint`` file in your working directory, it will be
|
||||
automatically loaded as configuration by yamllint.
|
||||
|
||||
.. rubric:: Footnotes
|
||||
|
||||
.. [#colored-output] The default output format is colored and inspired by
|
||||
`eslint <http://eslint.org/>`_, a great linting tool for Javascript.
|
||||
|
||||
BIN
docs/screenshot.png
Normal file
BIN
docs/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
4
setup.py
4
setup.py
@@ -26,7 +26,7 @@ setup(
|
||||
author=__author__,
|
||||
description=APP_DESCRIPTION,
|
||||
license=__license__,
|
||||
keywords=['yaml', 'lint', 'linter'],
|
||||
keywords=['yaml', 'lint', 'linter', 'syntax', 'checker'],
|
||||
url='https://github.com/adrienverge/yamllint',
|
||||
classifiers=[
|
||||
'Development Status :: 4 - Beta',
|
||||
@@ -45,6 +45,8 @@ setup(
|
||||
scripts=['bin/yamllint'],
|
||||
package_data={'yamllint': ['conf/*.yml']},
|
||||
install_requires=['pyyaml'],
|
||||
setup_requires=['pyyaml'], # importing `yamllint` (for APP_NAME etc.)
|
||||
# requires importing `yaml`
|
||||
tests_require=['nose'],
|
||||
test_suite='nose.collector',
|
||||
)
|
||||
|
||||
@@ -22,7 +22,7 @@ from yamllint import parser
|
||||
|
||||
|
||||
APP_NAME = 'yamllint'
|
||||
APP_VERSION = '0.5.0'
|
||||
APP_VERSION = '0.5.1'
|
||||
APP_DESCRIPTION = 'A linter for YAML files.'
|
||||
|
||||
__author__ = u'Adrien Vergé'
|
||||
|
||||
Reference in New Issue
Block a user