diff options
Diffstat (limited to 'bitbake/doc/Makefile')
| -rw-r--r-- | bitbake/doc/Makefile | 108 |
1 files changed, 26 insertions, 82 deletions
diff --git a/bitbake/doc/Makefile b/bitbake/doc/Makefile index 3c28f4b222..996f01b7d5 100644 --- a/bitbake/doc/Makefile +++ b/bitbake/doc/Makefile @@ -1,91 +1,35 @@ -# This is a single Makefile to handle all generated BitBake documents. -# The Makefile needs to live in the documentation directory and all figures used -# in any manuals must be .PNG files and live in the individual book's figures -# directory. -# -# The Makefile has these targets: -# -# pdf: generates a PDF version of a manual. -# html: generates an HTML version of a manual. -# tarball: creates a tarball for the doc files. -# validate: validates -# clean: removes files -# -# The Makefile generates an HTML version of every document. The -# variable DOC indicates the folder name for a given manual. -# -# To build a manual, you must invoke 'make' with the DOC argument. -# -# Examples: -# -# make DOC=bitbake-user-manual -# make pdf DOC=bitbake-user-manual -# -# The first example generates the HTML version of the User Manual. -# The second example generates the PDF version of the User Manual. +# Minimal makefile for Sphinx documentation # -ifeq ($(DOC),bitbake-user-manual) -XSLTOPTS = --stringparam html.stylesheet bitbake-user-manual-style.css \ - --stringparam chapter.autolabel 1 \ - --stringparam section.autolabel 1 \ - --stringparam section.label.includes.component.label 1 \ - --xinclude -ALLPREQ = html tarball -TARFILES = bitbake-user-manual-style.css bitbake-user-manual.html figures/bitbake-title.png -MANUALS = $(DOC)/$(DOC).html -FIGURES = figures -STYLESHEET = $(DOC)/*.css +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= -W --keep-going -j auto +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build +DESTDIR = final +ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0) +$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed") endif -## -# These URI should be rewritten by your distribution's xml catalog to -# match your localy installed XSL stylesheets. -XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current -XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -all: $(ALLPREQ) +.PHONY: help Makefile clean publish -pdf: -ifeq ($(DOC),bitbake-user-manual) - @echo " " - @echo "********** Building."$(DOC) - @echo " " - cd $(DOC); ../tools/docbook-to-pdf $(DOC).xml ../template; cd .. -endif - -html: -ifeq ($(DOC),bitbake-user-manual) -# See http://www.sagehill.net/docbookxsl/HtmlOutput.html - @echo " " - @echo "******** Building "$(DOC) - @echo " " - cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd .. -endif - -tarball: html - @echo " " - @echo "******** Creating Tarball of document files" - @echo " " - cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd .. - -validate: - cd $(DOC); xmllint --postvalid --xinclude --noout $(DOC).xml; cd .. - -publish: - @if test -f $(DOC)/$(DOC).html; \ - then \ - echo " "; \ - echo "******** Publishing "$(DOC)".html"; \ - echo " "; \ - scp -r $(MANUALS) $(STYLESHEET) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \ - cd $(DOC); scp -r $(FIGURES) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \ - else \ - echo " "; \ - echo $(DOC)".html missing. Generate the file first then try again."; \ - echo " "; \ - fi +publish: Makefile html singlehtml + rm -rf $(BUILDDIR)/$(DESTDIR)/ + mkdir -p $(BUILDDIR)/$(DESTDIR)/ + cp -r $(BUILDDIR)/html/* $(BUILDDIR)/$(DESTDIR)/ + cp $(BUILDDIR)/singlehtml/index.html $(BUILDDIR)/$(DESTDIR)/singleindex.html + sed -i -e 's@index.html#@singleindex.html#@g' $(BUILDDIR)/$(DESTDIR)/singleindex.html clean: - rm -rf $(MANUALS); rm $(DOC)/$(DOC).tgz; + @rm -rf $(BUILDDIR) + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |