Commit 62924fd7 authored by Rémy Léone's avatar Rémy Léone Committed by Jonathan Corbet
Browse files

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: default avatarJani Nikula <jani.nikula@intel.com>
Tested-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarRémy Léone <remy.leone@gmail.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 72f8f677

Documentation/DocBook/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -71,6 +71,7 @@ installmandocs: mandocs 
# no-op for the DocBook toolchain

epubdocs:

latexdocs:

linkcheckdocs:



###

#External programs used

Documentation/Makefile.sphinx

+4 −0
Original line number Diff line number Diff line
@@ -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'

Documentation/media/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -103,6 +103,7 @@ html: all 
epub: all

xml: all

latex: $(IMGPDF) all

linkcheck:



clean:

	-rm -f $(DOTTGT) $(IMGTGT) ${TARGETS} 2>/dev/null

Makefile

+1 −1
Original line number Diff line number Diff line
@@ -1444,7 +1444,7 @@ $(help-board-dirs): help-%: 


# Documentation targets

# ---------------------------------------------------------------------------

DOC_TARGETS := xmldocs sgmldocs psdocs latexdocs pdfdocs htmldocs mandocs installmandocs epubdocs cleandocs

DOC_TARGETS := xmldocs sgmldocs psdocs latexdocs pdfdocs htmldocs mandocs installmandocs epubdocs cleandocs linkcheckdocs

PHONY += $(DOC_TARGETS)

$(DOC_TARGETS): scripts_basic FORCE

	$(Q)$(MAKE) $(build)=scripts build_docproc build_check-lc_ctype

CRA Git | Maintained and supported by SUSTech CRA and CCSE