Remi Pointel
cb5fe2c050
add OpenBSD installation instructions.
2019-07-09 10:04:48 +02:00
Adrien Vergé
930c8eea94
docs: Simplify installation instruction in the README
2019-07-07 18:13:43 +02:00
Adrien Vergé
f66661e36d
docs(cli): Add a paragraph about standard input
...
See commit 05dfcbc
2019-02-11 14:16:33 +01:00
Adrien Vergé
a56a1015f0
style(docs): Fix RST lint errors reported by doc8
2018-12-08 11:21:02 +01:00
Adrien Vergé
66adaee66c
docs: Add documentation on the new -f colored option
2018-11-14 19:02:52 +01:00
Adrien Vergé
203cfc20f0
docs: Remove sudo from pip installation instructions
2018-05-09 20:20:18 +02:00
Adrien Vergé
51c30505b5
docs: Add Mac OS installation instructions
...
See https://github.com/adrienverge/yamllint/issues/91 and
https://github.com/Homebrew/homebrew-core/blob/af2bbe9/Formula/yamllint.rb
2018-05-09 20:19:03 +02:00
Adrien Vergé
ff9ebde608
docs: Remove old Debian / Ubuntu installation instructions
2018-05-09 20:19:03 +02:00
Adrien Vergé
2b7f5c5e72
docs(install): Update Debian version
...
yamllint is now backported in Debian 8 (Jessie):
https://tracker.debian.org/pkg/yamllint
https://packages.debian.org/source/jessie-backports/yamllint
2016-11-16 18:50:13 +01:00
Adrien Vergé
a483524b63
Doc: Update installing section
...
Packages are now also available in Debian and Ubuntu.
2016-03-15 10:04:24 +01:00
Adrien Vergé
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
2016-03-07 11:15:04 +01:00
Adrien Vergé
688858e639
Doc: Reference Fedora and Ubuntu packages
2016-03-07 11:05:29 +01:00
Adrien Vergé
3f4f13e848
Doc: Update screenshot to include 'key-duplicates'
2016-02-01 22:41:56 +01:00
Adrien Vergé
fee72d484e
Doc: Add a screenshot
2016-01-23 14:30:24 +01:00
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/
2016-01-22 18:20:28 +01:00
