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=<doc directory name> 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/<Release MM.mm>/<doc name> 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: b5cb0801691dbedfa9d3733a6b62450c8a674fa0) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-07-27 07:27:12 +00:00 · 2011-06-02 10:18:35 -07:00
parent 78d092fe7a
commit a02537187f
7 changed files with 84 additions and 301 deletions
@@ -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)