summaryrefslogtreecommitdiffstats
path: root/documentation/Makefile
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-20 20:17:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-04 10:55:00 +0000
commitfa0cb4d34b1073f215fa3c680f2316208739d53d (patch)
treeba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/Makefile
parenta038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff)
downloadpoky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz
sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/Makefile')
-rw-r--r--documentation/Makefile67
1 files changed, 13 insertions, 54 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index 15644bf926..7d4058ae75 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -1,3 +1,6 @@
1#
2# SPDX-License-Identifier: CC-BY-2.0-UK
3#
1# This is a single Makefile to handle all generated Yocto Project documents, 4# This is a single Makefile to handle all generated Yocto Project documents,
2# which includes the BitBake User Manual and the Toaster User Manual. 5# which includes the BitBake User Manual and the Toaster User Manual.
3# The Makefile needs to live in the documents directory and all figures used 6# The Makefile needs to live in the documents directory and all figures used
@@ -137,32 +140,10 @@ ALLPREQ = html tarball
137# This would be appropriate for "master" branch. 140# This would be appropriate for "master" branch.
138# 141#
139 142
140 ifeq ($(BRANCH),edison)
141TARFILES = dev-style.css dev-manual.html \
142 figures/app-dev-flow.png figures/bsp-dev-flow.png \
143 figures/dev-title.png figures/git-workflow.png \
144 figures/index-downloads.png figures/kernel-dev-flow.png \
145 figures/kernel-example-repos-edison.png \
146 figures/kernel-overview-1.png figures/kernel-overview-2.png \
147 figures/kernel-overview-3-edison.png \
148 figures/source-repos.png figures/yp-download.png \
149 figures/wip.png
150 else ifeq ($(BRANCH),denzil)
151TARFILES = dev-style.css dev-manual.html \
152 figures/app-dev-flow.png figures/bsp-dev-flow.png \
153 figures/dev-title.png figures/git-workflow.png \
154 figures/index-downloads.png figures/kernel-dev-flow.png \
155 figures/kernel-example-repos-denzil.png \
156 figures/kernel-overview-1.png figures/kernel-overview-2.png \
157 figures/kernel-overview-3-denzil.png \
158 figures/source-repos.png figures/yp-download.png \
159 figures/wip.png
160 else
161TARFILES = dev-style.css dev-manual.html figures/buildhistory-web.png \ 143TARFILES = dev-style.css dev-manual.html figures/buildhistory-web.png \
162 figures/dev-title.png figures/buildhistory.png \ 144 figures/dev-title.png figures/buildhistory.png \
163 figures/recipe-workflow.png figures/bitbake-build-flow.png \ 145 figures/recipe-workflow.png figures/bitbake-build-flow.png \
164 figures/multiconfig_files.png figures/cute-files-npm-example.png 146 figures/multiconfig_files.png figures/cute-files-npm-example.png
165 endif
166 147
167MANUALS = $(DOC)/$(DOC).html 148MANUALS = $(DOC)/$(DOC).html
168FIGURES = figures 149FIGURES = figures
@@ -178,37 +159,6 @@ XSLTOPTS = --stringparam html.stylesheet mega-style.css \
178 --xinclude 159 --xinclude
179ALLPREQ = html tarball 160ALLPREQ = html tarball
180 161
181 ifeq ($(BRANCH),edison)
182TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
183 figures/building-an-image.png \
184 figures/using-a-pre-built-image.png \
185 figures/poky-title.png \
186 figures/adt-title.png figures/bsp-title.png \
187 figures/kernel-title.png figures/kernel-architecture-overview.png \
188 figures/app-dev-flow.png figures/bsp-dev-flow.png \
189 figures/dev-title.png figures/git-workflow.png \
190 figures/index-downloads.png figures/kernel-dev-flow.png \
191 figures/kernel-example-repos-edison.png \
192 figures/kernel-overview-1.png figures/kernel-overview-2.png \
193 figures/kernel-overview-3-edison.png \
194 figures/source-repos.png figures/yp-download.png \
195 figures/wip.png
196 else ifeq ($(BRANCH),denzil)
197TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
198 figures/building-an-image.png \
199 figures/using-a-pre-built-image.png \
200 figures/poky-title.png \
201 figures/adt-title.png figures/bsp-title.png \
202 figures/kernel-title.png figures/kernel-architecture-overview.png \
203 figures/app-dev-flow.png figures/bsp-dev-flow.png \
204 figures/dev-title.png figures/git-workflow.png \
205 figures/index-downloads.png figures/kernel-dev-flow.png \
206 figures/kernel-example-repos-denzil.png \
207 figures/kernel-overview-1.png figures/kernel-overview-2.png \
208 figures/kernel-overview-3-denzil.png \
209 figures/source-repos.png figures/yp-download.png \
210 figures/wip.png
211 else
212TARFILES = mega-manual.html mega-style.css \ 162TARFILES = mega-manual.html mega-style.css \
213 figures/YP-flow-diagram.png \ 163 figures/YP-flow-diagram.png \
214 figures/using-a-pre-built-image.png \ 164 figures/using-a-pre-built-image.png \
@@ -266,7 +216,6 @@ TARFILES = mega-manual.html mega-style.css \
266 figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/bypqs-title.png \ 216 figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/bypqs-title.png \
267 figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png \ 217 figures/overview-manual-title.png figures/sdk-autotools-flow.png figures/sdk-makefile-flow.png \
268 figures/bb_multiconfig_files.png figures/bitbake-title.png figures/cute-files-npm-example.png 218 figures/bb_multiconfig_files.png figures/bitbake-title.png figures/cute-files-npm-example.png
269 endif
270 219
271MANUALS = $(DOC)/$(DOC).html 220MANUALS = $(DOC)/$(DOC).html
272FIGURES = figures 221FIGURES = figures
@@ -355,6 +304,16 @@ STYLESHEET = $(DOC)/*.css
355endif 304endif
356 305
357 306
307ifeq ($(DOC),test-manual)
308XSLTOPTS = --xinclude
309ALLPREQ = html tarball
310TARFILES = test-manual.html test-manual-style.css \
311 figures/test-manual-title.png figures/ab-test-cluster.png
312MANUALS = $(DOC)/$(DOC).html
313FIGURES = figures
314STYLESHEET = $(DOC)/*.css
315endif
316
358## 317##
359# These URI should be rewritten by your distribution's xml catalog to 318# These URI should be rewritten by your distribution's xml catalog to
360# match your locally installed XSL stylesheets. 319# match your locally installed XSL stylesheets.