From 37eedd0ae3593f759a5e9e70e9dc1191171e09d0 Mon Sep 17 00:00:00 2001 From: Beth Flanagan Date: Thu, 2 Jun 2011 10:18:35 -0700 Subject: documentation: [YOCTO #1025] build system for docs These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC= make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs// The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan Signed-off-by: Richard Purdie --- documentation/Makefile | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 documentation/Makefile (limited to 'documentation/Makefile') diff --git a/documentation/Makefile b/documentation/Makefile new file mode 100644 index 0000000000..a22abb23c2 --- /dev/null +++ b/documentation/Makefile @@ -0,0 +1,84 @@ +DISTROVERSION=1.1 +ifeq ($(DOC),bsp-guide) +XSLTOPTS = --stringparam html.stylesheet style.css \ + --stringparam chapter.autolabel 1 \ + --stringparam section.autolabel 1 \ + --stringparam section.label.includes.component.label 1 \ + --xinclude +ALLPREQ = html pdf tarball +TARFILES = style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png +endif + +ifeq ($(DOC),yocto-project-qs) +XSLTOPTS = --stringparam html.stylesheet style.css \ + --xinclude +ALLPREQ = html tarball +TARFILES = yocto-project-qs.html style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/yocto-project-transp.png +endif + +ifeq ($(DOC),poky-ref-manual) +XSLTOPTS = --stringparam html.stylesheet style.css \ + --stringparam chapter.autolabel 1 \ + --stringparam appendix.autolabel A \ + --stringparam section.autolabel 1 \ + --stringparam section.label.includes.component.label 1 \ + --xinclude +ALLPREQ = html pdf tarball +TARFILES = poky-ref-manual.html style.css figures/poky-title.png figures/ss-sato.png +endif + + +ifeq ($(DOC),adt-manual) +XSLTOPTS = --stringparam html.stylesheet style.css \ + --stringparam chapter.autolabel 1 \ + --stringparam appendix.autolabel A \ + --stringparam section.autolabel 1 \ + --stringparam section.label.includes.component.label 1 \ + --xinclude +ALLPREQ = html pdf tarball +TARFILES = adt-manual.html adt-manual.pdf style.css figures/adt-title.png +endif + +ifeq ($(DOC),kernel-manual) +XSLTOPTS = --stringparam html.stylesheet style.css \ + --stringparam chapter.autolabel 1 \ + --stringparam appendix.autolabel A \ + --stringparam section.autolabel 1 \ + --stringparam section.label.includes.component.label 1 \ + --xinclude +ALLPREQ = html pdf tarball +TARFILES = kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-architecture-overview.png +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 + +all: $(ALLPREQ) + +pdf: + cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd .. + +html: +# See http://www.sagehill.net/docbookxsl/HtmlOutput.html + cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd .. + +tarball: html + cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd .. + +validate: + cd $(DOC); xmllint --postvalid --xinclude --noout $(DOC).xml; cd .. + +MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf +FIGURES = $(DOC)/figures/*.png +STYLESHEET = *.css + +publish: + scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(DISTROVERSION)/$(DOC) + scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(DISTROVERSION)/$(DOC)/figures + +clean: + rm -f $(MANUALS) -- cgit v1.2.3-54-g00ecf