Files
yamllint/docs/index.rst
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

19 lines
240 B
ReStructuredText

yamllint documentation
======================
.. toctree::
:maxdepth: 2
quickstart
configuration
rules
development
text_editors
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`