doc: add texinfodocs and infodocs targets

Sphinx supports generating Texinfo sources and Info documentation,
which can be navigated easily and is convenient to search (via the
indexed nodes or anchors, for example).  This is basically the same as
1f050e904dd6f2955eecbd22031d912ccb2e7683, which was recently applied
to the Linux kernel.

Signed-off-by: Maxim Cournoyer <maxim.cournoyer@savoirfairelinux.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

diff --git a/Makefile b/Makefile
index c977c906b03622106d9cf3458af9e144be6b4a38..66cfbb1dfee7fe350d2420cfa43d739bc9ff6716 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -2372,7 +2372,7 @@ tcheck:
 # Documentation targets
 # ---------------------------------------------------------------------------
 DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs \
-              linkcheckdocs dochelp refcheckdocs
+              linkcheckdocs dochelp refcheckdocs texinfodocs infodocs
 PHONY += $(DOC_TARGETS)
 $(DOC_TARGETS): scripts_basic FORCE
        $(Q)$(MAKE) $(build)=doc $@

diff --git a/doc/Makefile b/doc/Makefile
index f5de65e92782236c2f7a4282a5669d354f50287c..d0904a9f9904905fb1e0e1cbaaeae173623b20b4 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -69,6 +69,14 @@ quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
 htmldocs:
        @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
 
+texinfodocs:
+       @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),texinfo,$(var)))
+
+# Note: the 'info' Make target is generated by sphinx itself when
+# running the texinfodocs target defined above.
+infodocs: texinfodocs
+       $(MAKE) -C $(BUILDDIR)/texinfo info
+
 linkcheckdocs:
        @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
 
@@ -109,6 +117,8 @@ cleandocs:
 dochelp:
        @echo  ' U-Boot documentation in different formats from ReST:'
        @echo  '  htmldocs        - HTML'
+       @echo  '  texinfodocs     - Texinfo'
+       @echo  '  infodocs        - Info'
        @echo  '  latexdocs       - LaTeX'
        @echo  '  pdfdocs         - PDF'
        @echo  '  epubdocs        - EPUB'

diff --git a/doc/conf.py b/doc/conf.py
index 62c8d31270c042ee347e997719409d4a11c9d5dc..3db70f80c1204ea558792208d36ff2bf84f1eb6a 100644 (file)
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -449,7 +449,7 @@ for fn in os.listdir('.'):
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'dasuboot', 'The U-Boot Documentation',
+    (master_doc, 'u-boot', 'The U-Boot Documentation',
      [author], 1)
 ]
 
@@ -463,8 +463,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'DasUBoot', 'The U-Boot Documentation',
-     author, 'DasUBoot', 'One line description of project.',
+    (master_doc, 'u-boot', 'The U-Boot Documentation',
+     author, 'U-Boot', 'Boot loader for embedded systems',
      'Miscellaneous'),
 ]
 

diff --git a/doc/media/Makefile b/doc/media/Makefile
index b9b43a34c362a7aa61a4a0d1ed6a1089883a4f6d..9b32258696ba3fe3440e14fc3f18df0ebd7cec39 100644 (file)
--- a/doc/media/Makefile
+++ b/doc/media/Makefile
@@ -22,10 +22,11 @@ $(BUILDDIR)/linker_lists.h.rst: ${API}/linker_lists.h ${PARSER} $(SRC_DIR)/linke
 
 # Media build rules
 
-.PHONY: all html epub xml latex
+.PHONY: all html texinfo epub xml latex
 
 all: $(IMGDOT) $(BUILDDIR) ${TARGETS}
 html: all
+texinfo: all
 epub: all
 xml: all
 latex: $(IMGPDF) all