Commit Graph

4 Commits (961c496b4f8cf8213b0f67b8137bd3e7c243b5fe)

Author SHA1 Message Date
Adrien Vergé d6b89e94e4 chore(docs): Fix conf.py styling 6 years ago
Adrien Vergé c4a3e15ff0 docs(readthedocs): Fix builds on yamllint.readthedocs.io
Documentation builds on readthedocs.io partly fail because some modules
imported by yammlint cannot be imported in Sphinx automodule.

This commit fixes that using the tip at [1].

Closes #66

[1]: http://docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
7 years ago
Adrien Vergé 83384fa4cf Doc: Fix man page redundant description 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