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/
This commit is contained in:
Adrien Vergé
2016-01-21 21:48:57 +01:00
parent 1bfd18097a
commit 38234a1d3c
10 changed files with 458 additions and 2 deletions

View File

@@ -25,8 +25,8 @@ APP_NAME = 'yamllint'
APP_VERSION = '0.4.0'
APP_DESCRIPTION = 'A linter for YAML files.'
__author__ = 'Adrien Vergé'
__copyright__ = 'Copyright 2016, Adrien Vergé'
__author__ = u'Adrien Vergé'
__copyright__ = u'Copyright 2016, Adrien Vergé'
__license__ = 'GPLv3'
__version__ = APP_VERSION