mirror of
https://github.com/adrienverge/yamllint.git
synced 2025-02-25 18:55:20 -06:00
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.
This commit is contained in:
parent
771c3a0412
commit
16eae28a50
2
.github/workflows/ci.yaml
vendored
2
.github/workflows/ci.yaml
vendored
@ -28,7 +28,7 @@ jobs:
|
||||
- run: doc8 $(git ls-files '*.rst')
|
||||
- run: rstcheck --ignore-directives automodule $(git ls-files '*.rst')
|
||||
- run: yamllint --strict $(git ls-files '*.yaml' '*.yml')
|
||||
- run: python setup.py build_sphinx
|
||||
- run: make -C docs html
|
||||
- name: Check for broken links in documentation
|
||||
run: make -C docs linkcheck
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXOPTS = -W
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
Loading…
Reference in New Issue
Block a user