diff options
author | Rémy Léone <remy.leone@gmail.com> | 2017-02-15 13:16:35 +0100 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2017-02-15 15:22:47 -0700 |
commit | 62924fd789c6a381b772141f78a82361f46ae397 (patch) | |
tree | 6a746a4b1a84681e0170ca8d849f55ed2ab2f076 /Documentation/Makefile.sphinx | |
parent | 72f8f677e3ec685865392846c356e08771d49f13 (diff) | |
download | op-kernel-dev-62924fd789c6a381b772141f78a82361f46ae397.zip op-kernel-dev-62924fd789c6a381b772141f78a82361f46ae397.tar.gz |
Add a target to check broken external links in the Documentation
Documentation shouldn't have broken links.
sphinx linkcheck builder scans all documents for external links, tries
to open them with urllib2, and writes an overview which ones are broken
and redirected to standard output and to output.txt in the output
directory.
Reviewed-by: Jani Nikula <jani.nikula@intel.com>
Tested-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Rémy Léone <remy.leone@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/Makefile.sphinx')
-rw-r--r-- | Documentation/Makefile.sphinx | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx index 8284f3d..bcf529f 100644 --- a/Documentation/Makefile.sphinx +++ b/Documentation/Makefile.sphinx @@ -69,6 +69,9 @@ quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) htmldocs: @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) +linkcheckdocs: + @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var))) + latexdocs: @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var))) @@ -117,6 +120,7 @@ dochelp: @echo ' pdfdocs - PDF' @echo ' epubdocs - EPUB' @echo ' xmldocs - XML' + @echo ' linkcheckdocs - check for broken external links (will connect to external hosts)' @echo ' cleandocs - clean all generated files' @echo @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' |