Commit Graph

6 Commits (1f1757ced42162993690b07560ffa168bea58108)

Author SHA1 Message Date
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
9 years ago
Adrien Vergé 7688567faa cli: Add the `-d` option to provide inline conf 9 years ago
Adrien Vergé 2f75e92a66 Doc: Add a configuration example in README 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é 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