diff options
author | Jani Nikula <jani.nikula@intel.com> | 2018-04-26 18:06:42 +0300 |
---|---|---|
committer | Jani Nikula <jani.nikula@intel.com> | 2018-04-26 18:43:06 +0300 |
commit | e6f9b663ee88c0a18a38b4b4f788887ee2a5a5b0 (patch) | |
tree | 9b6ba5fe78b6ca2d92887ed9afb0143ada86e95c | |
parent | 91a6c4c459fcdc33cdc40c5bbf02199e5efee16d (diff) |
build: add doccheck target to run the Sphinx HTML build with strict options
-E to ignore cached files, -n to run in nit-picky mode, -W to turn
warnings into errors, and -q for quiet.
Document the existing check targets in make help while at it.
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
-rw-r--r-- | Makefile | 12 |
1 files changed, 10 insertions, 2 deletions
@@ -57,7 +57,7 @@ mancheck: rst2man --strict --no-raw dim.rst >/dev/null rst2man --strict --no-raw qf.rst >/dev/null -check: shellcheck mancheck +check: shellcheck mancheck doccheck .PHONY: clean clean: @@ -71,10 +71,14 @@ help: @echo " singlehtml to make a single large HTML file" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " doccheck to check standalone HTML build" + @echo " mancheck to check man pages using rst2html" + @echo " shellcheck to check shell scripts using shellcheck" + @echo " check to run all *check targets" # FIXME: This works for the first build, but not for updates. Look into using # Sphinx extensions for both the graphviz and wavedrom parts. -html dirhtml singlehtml linkcheck doctest: drm-intel-flow.svg drm-misc-commit-flow.svg +html dirhtml singlehtml linkcheck doctest doccheck: drm-intel-flow.svg drm-misc-commit-flow.svg .PHONY: html html: @@ -106,3 +110,7 @@ doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: doccheck +doccheck: + $(SPHINXBUILD) -EWnq -b html $(ALLSPHINXOPTS) $(BUILDDIR)/doccheck |