Commit Graph

12 Commits (ba140ad42cdd0702bbe0108a1ecf9f093f6471d9)

Author SHA1 Message Date
Adrien Vergé 0e04ee29e6 Doc: Update description 9 years ago
Adrien Vergé 3f4f13e848 Doc: Update screenshot to include 'key-duplicates' 9 years ago
Adrien Vergé f6bab05e8a Rules: Add the 'key-duplicates' rule 9 years ago
Adrien Vergé d2b5f69309 Doc: Update Vim integration documentation
Since it has been merged into Syntastic:
https://github.com/scrooloose/syntastic/commit/8c4dadc
https://github.com/scrooloose/syntastic/pull/1675
9 years ago
Adrien Vergé 376a6ed484 Doc: Enhance short description 9 years ago
Adrien Vergé dbbecb5875 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.
9 years ago
Adrien Vergé fee72d484e Doc: Add a screenshot 9 years ago
Adrien Vergé ba8a9d0ba1 Doc: Give an explicit link from configuration to rules 9 years ago
Adrien Vergé 47d6534e75 Doc: Write the configuration page 9 years ago
Adrien Vergé 237db5aeef Doc: Document how to use the yamllint Python module 9 years ago
Adrien Vergé 6e9de02eac Doc: Update index
Add a brief description and remove unused links.
9 years ago
Adrien Vergé 38234a1d3c 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