yamllint

Mirrors/yamllint

Fork 0

Commit Graph

Author	SHA1	Message	Date
Adrien Vergé	16eae28a50	build: Stop using setup.py to generate documentation Because `setup.py` is deprecated, let's switch from: python setup.py build_sphinx to: make -C docs html to build Sphinx documentation. The generated HTML files in `docs/_build/html` are exactly the same (I compared with `diff -qr`). Also add `-W` (turn warnings into errors) to the `sphinx-build` options to keep the previous behavior.	2023-04-14 16:03:32 +02: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é

16eae28a50

build: Stop using setup.py to generate documentation

Because `setup.py` is deprecated, let's switch from:

    python setup.py build_sphinx

to:

    make -C docs html

to build Sphinx documentation.

The generated HTML files in `docs/_build/html` are exactly the same (I
compared with `diff -qr`).

Also add `-W` (turn warnings into errors) to the `sphinx-build` options
to keep the previous behavior.

2023-04-14 16:03:32 +02: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

2 Commits