On Wed, 15 Feb 2017, Remy Leone <[email protected]> wrote:
> From: Rémy Léone <[email protected]>
>
> 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.
>
> Signed-off-by: Rémy Léone <[email protected]>
> ---
> Documentation/DocBook/Makefile | 1 +
> Documentation/Makefile.sphinx | 4 ++++
> Documentation/media/Makefile | 1 +
> Makefile | 2 +-
> 4 files changed, 7 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
> index a6eb7dc..ef24346 100644
> --- a/Documentation/DocBook/Makefile
> +++ b/Documentation/DocBook/Makefile
> @@ -71,6 +71,7 @@ installmandocs: mandocs
> # no-op for the DocBook toolchain
> epubdocs:
> latexdocs:
> +linkcheck:
Nope, *just* the Documentation/media/Makefile needed the change from
linkcheckdocs to linkcheck...
make SPHINXDIRS= linkcheckdocs
make[1]: 'linkcheckdocs' is up to date.
make[1]: *** No rule to make target 'linkcheckdocs'. Stop.
Makefile:1450: recipe for target 'linkcheckdocs' failed
make: *** [linkcheckdocs] Error 2
BR,
Jani.
>
> ###
> #External programs used
> diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
> index 707c653..c320458 100644
> --- a/Documentation/Makefile.sphinx
> +++ b/Documentation/Makefile.sphinx
> @@ -68,6 +68,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)))
>
> @@ -109,6 +112,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'
> diff --git a/Documentation/media/Makefile b/Documentation/media/Makefile
> index 3266360..8df0cf0 100644
> --- a/Documentation/media/Makefile
> +++ b/Documentation/media/Makefile
> @@ -103,6 +103,7 @@ html: all
> epub: all
> xml: all
> latex: $(IMGPDF) all
> +linkcheck:
>
> clean:
> -rm -f $(DOTTGT) $(IMGTGT) ${TARGETS} 2>/dev/null
> diff --git a/Makefile b/Makefile
> index 96e2352..416849c0 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -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
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
