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-21 21:48:57 +01:00
parent 1bfd18097a
commit 38234a1d3c
10 changed files with 458 additions and 2 deletions
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -0,0 +1,5 @@
+Configuration
+=============
+
+yamllint uses a set of *rules* to check sources files for problems. Each rule is
+independent from the others, and can be enabled, disabled or tweaked.