64369db9a2
docs(configuration): Fix typo
8 years ago
bf386b3c90
docs: Explain strict mode return codes
8 years ago
4533b8ae49
doc(config): Show `relaxed` conf contents
...
Closes : #15
9 years ago
8c839a20c2
Config: Detect user config using `os.path.expanduser()`
...
Instead of `$HOME`, since the former works when `$HOME` is not set.
[1]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=828033#10
9 years ago
598e5e4370
Doc: Fix typo on configuration page intro
9 years ago
03076ee214
Doc: Add a pointer to rules on configuration page intro
9 years ago
eabd349902
Config: Allow a user-global configuration file
...
Instead of just looking for `.yamllint` in the current working
directory, also look for `~/.config/yamllint/config` (using
`$XDG_CONFIG_HOME` or `$HOME`, see [1] and [2] for information).
[1]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-0.6.html
[2]: https://wiki.archlinux.org/index.php/XDG_Base_Directory_support
Closes : #6
9 years ago
41733fc7a5
Use '.yaml' extension as default, not '.yml'
...
As someone said [1] on the internet:
Say ".yaml" not ".yml".
This is not MS-DOS, and YML is a Yahoo XML dialect.
Similarly, we use '.json', not '.jsn'.
[1]: https://github.com/ceph/s3-tests/commit/e17c56a
9 years ago
7688567faa
cli: Add the `-d` option to provide inline conf
9 years ago
2f75e92a66
Doc: Add a configuration example in README
9 years ago
ba8a9d0ba1
Doc: Give an explicit link from configuration to rules
9 years ago
47d6534e75
Doc: Write the configuration page
9 years ago
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
Adrien Vergé
Jonathan Sokolowski