summaryrefslogtreecommitdiffstats
path: root/documentation/Makefile
diff options
context:
space:
mode:
authorBeth Flanagan <elizabeth.flanagan@intel.com>2011-06-02 10:18:35 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-06-13 22:38:03 +0100
commit37eedd0ae3593f759a5e9e70e9dc1191171e09d0 (patch)
treeca2ae81c1163b3bdd7763d2e0dfcc5df282e5b72 /documentation/Makefile
parentbaf6bf4a5de176a5ad0fbaf436134c767eeed9ac (diff)
downloadpoky-37eedd0ae3593f759a5e9e70e9dc1191171e09d0.tar.gz
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: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/Makefile')
-rw-r--r--documentation/Makefile84
1 files changed, 84 insertions, 0 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
new file mode 100644
index 0000000000..a22abb23c2
--- /dev/null
+++ b/documentation/Makefile
@@ -0,0 +1,84 @@
1DISTROVERSION=1.1
2ifeq ($(DOC),bsp-guide)
3XSLTOPTS = --stringparam html.stylesheet style.css \
4 --stringparam chapter.autolabel 1 \
5 --stringparam section.autolabel 1 \
6 --stringparam section.label.includes.component.label 1 \
7 --xinclude
8ALLPREQ = html pdf tarball
9TARFILES = style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png
10endif
11
12ifeq ($(DOC),yocto-project-qs)
13XSLTOPTS = --stringparam html.stylesheet style.css \
14 --xinclude
15ALLPREQ = html tarball
16TARFILES = 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
17endif
18
19ifeq ($(DOC),poky-ref-manual)
20XSLTOPTS = --stringparam html.stylesheet style.css \
21 --stringparam chapter.autolabel 1 \
22 --stringparam appendix.autolabel A \
23 --stringparam section.autolabel 1 \
24 --stringparam section.label.includes.component.label 1 \
25 --xinclude
26ALLPREQ = html pdf tarball
27TARFILES = poky-ref-manual.html style.css figures/poky-title.png figures/ss-sato.png
28endif
29
30
31ifeq ($(DOC),adt-manual)
32XSLTOPTS = --stringparam html.stylesheet style.css \
33 --stringparam chapter.autolabel 1 \
34 --stringparam appendix.autolabel A \
35 --stringparam section.autolabel 1 \
36 --stringparam section.label.includes.component.label 1 \
37 --xinclude
38ALLPREQ = html pdf tarball
39TARFILES = adt-manual.html adt-manual.pdf style.css figures/adt-title.png
40endif
41
42ifeq ($(DOC),kernel-manual)
43XSLTOPTS = --stringparam html.stylesheet style.css \
44 --stringparam chapter.autolabel 1 \
45 --stringparam appendix.autolabel A \
46 --stringparam section.autolabel 1 \
47 --stringparam section.label.includes.component.label 1 \
48 --xinclude
49ALLPREQ = html pdf tarball
50TARFILES = kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-architecture-overview.png
51endif
52
53
54##
55# These URI should be rewritten by your distribution's xml catalog to
56# match your localy installed XSL stylesheets.
57XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
58XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
59
60all: $(ALLPREQ)
61
62pdf:
63 cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd ..
64
65html:
66# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
67 cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
68
69tarball: html
70 cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
71
72validate:
73 cd $(DOC); xmllint --postvalid --xinclude --noout $(DOC).xml; cd ..
74
75MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
76FIGURES = $(DOC)/figures/*.png
77STYLESHEET = *.css
78
79publish:
80 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(DISTROVERSION)/$(DOC)
81 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(DISTROVERSION)/$(DOC)/figures
82
83clean:
84 rm -f $(MANUALS)