On 12/18/22 01:31, Maxim Cournoyer wrote:
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
Hello Maxim,
the texinfodocs and infodocs targets can be built now.
After navigating to doc/output/texinfo and running 'sudo make install-info' the 'DasUBoot' chapter is available. This is not a good title. Can we change the title to 'U-Boot' in doc/conf.py:466?
'One line description of project.' is not a reasonable text either (doc/conf.py:467). I would suggest the following:
diff --git a/doc/conf.py b/doc/conf.py index 62c8d31270..b973143ee0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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'), ]
Best regards
Heinrich
Changes in v2:
Do not invoke nonexistent 'sphinx-pre-install' script
Makefile | 2 +- doc/Makefile | 10 ++++++++++ doc/media/Makefile | 3 ++- 3 files changed, 13 insertions(+), 2 deletions(-)
diff --git a/Makefile b/Makefile index de5746399a..597a8886c3 100644 --- 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 infodocsdiff --git a/doc/Makefile b/doc/Makefile index f5de65e927..d0904a9f99 100644 --- 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/media/Makefile b/doc/media/Makefile index b9b43a34c3..9b32258696 100644 --- 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
base-commit: 9bd3d354a1a0712ac27c717df9ad60566b0406ee