yamllint

Mirrors/yamllint

Fork 0

Commit Graph

Author	SHA1	Message	Date
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	2017-09-03 16:08:42 +02:00
Adrien Vergé	83384fa4cf	Doc: Fix man page redundant description	2016-02-19 19:34:20 +01:00
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

Author

SHA1

Message

Date

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

2017-09-03 16:08:42 +02:00

Adrien Vergé

83384fa4cf

Doc: Fix man page redundant description

2016-02-19 19:34:20 +01:00

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

3 Commits