Commit Graph

7 Commits (151b1c4086c20763030b1cd61f90788489d0efdf)

Author SHA1 Message Date
blackillzone c8e516be2f Add documentation for pre-commit 8 years ago
Adrien Vergé 0eb310e102 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
9 years ago
Adrien Vergé 0e04ee29e6 Doc: Update description 9 years ago
Adrien Vergé 376a6ed484 Doc: Enhance short description 9 years ago
Adrien Vergé fee72d484e Doc: Add a screenshot 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