diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-11-20 20:17:33 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-04 10:55:00 +0000 |
commit | fa0cb4d34b1073f215fa3c680f2316208739d53d (patch) | |
tree | ba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/sphinx-static/switchers.js | |
parent | a038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff) | |
download | poky-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/sphinx-static/switchers.js')
-rw-r--r-- | documentation/sphinx-static/switchers.js | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js new file mode 100644 index 0000000000..32113cfa96 --- /dev/null +++ b/documentation/sphinx-static/switchers.js | |||
@@ -0,0 +1,233 @@ | |||
1 | (function() { | ||
2 | 'use strict'; | ||
3 | |||
4 | var all_versions = { | ||
5 | 'dev': 'dev (3.2)', | ||
6 | '3.1.2': '3.1.2', | ||
7 | '3.0.3': '3.0.3', | ||
8 | '2.7.4': '2.7.4', | ||
9 | }; | ||
10 | |||
11 | var all_doctypes = { | ||
12 | 'single': 'Individual Webpages', | ||
13 | 'mega': "All-in-one 'Mega' Manual", | ||
14 | }; | ||
15 | |||
16 | // Simple version comparision | ||
17 | // Return 1 if a > b | ||
18 | // Return -1 if a < b | ||
19 | // Return 0 if a == b | ||
20 | function ver_compare(a, b) { | ||
21 | if (a == "dev") { | ||
22 | return 1; | ||
23 | } | ||
24 | |||
25 | if (a === b) { | ||
26 | return 0; | ||
27 | } | ||
28 | |||
29 | var a_components = a.split("."); | ||
30 | var b_components = b.split("."); | ||
31 | |||
32 | var len = Math.min(a_components.length, b_components.length); | ||
33 | |||
34 | // loop while the components are equal | ||
35 | for (var i = 0; i < len; i++) { | ||
36 | // A bigger than B | ||
37 | if (parseInt(a_components[i]) > parseInt(b_components[i])) { | ||
38 | return 1; | ||
39 | } | ||
40 | |||
41 | // B bigger than A | ||
42 | if (parseInt(a_components[i]) < parseInt(b_components[i])) { | ||
43 | return -1; | ||
44 | } | ||
45 | } | ||
46 | |||
47 | // If one's a prefix of the other, the longer one is greater. | ||
48 | if (a_components.length > b_components.length) { | ||
49 | return 1; | ||
50 | } | ||
51 | |||
52 | if (a_components.length < b_components.length) { | ||
53 | return -1; | ||
54 | } | ||
55 | |||
56 | // Otherwise they are the same. | ||
57 | return 0; | ||
58 | } | ||
59 | |||
60 | function build_version_select(current_series, current_version) { | ||
61 | var buf = ['<select>']; | ||
62 | |||
63 | $.each(all_versions, function(version, title) { | ||
64 | var series = version.substr(0, 3); | ||
65 | if (series == current_series) { | ||
66 | if (version == current_version) | ||
67 | buf.push('<option value="' + version + '" selected="selected">' + title + '</option>'); | ||
68 | else | ||
69 | buf.push('<option value="' + version + '">' + title + '</option>'); | ||
70 | |||
71 | if (version != current_version) | ||
72 | buf.push('<option value="' + current_version + '" selected="selected">' + current_version + '</option>'); | ||
73 | } else { | ||
74 | buf.push('<option value="' + version + '">' + title + '</option>'); | ||
75 | } | ||
76 | }); | ||
77 | |||
78 | buf.push('</select>'); | ||
79 | return buf.join(''); | ||
80 | } | ||
81 | |||
82 | function build_doctype_select(current_doctype) { | ||
83 | var buf = ['<select>']; | ||
84 | |||
85 | $.each(all_doctypes, function(doctype, title) { | ||
86 | if (doctype == current_doctype) | ||
87 | buf.push('<option value="' + doctype + '" selected="selected">' + | ||
88 | all_doctypes[current_doctype] + '</option>'); | ||
89 | else | ||
90 | buf.push('<option value="' + doctype + '">' + title + '</option>'); | ||
91 | }); | ||
92 | if (!(current_doctype in all_doctypes)) { | ||
93 | // In case we're browsing a doctype that is not yet in all_doctypes. | ||
94 | buf.push('<option value="' + current_doctype + '" selected="selected">' + | ||
95 | current_doctype + '</option>'); | ||
96 | all_doctypes[current_doctype] = current_doctype; | ||
97 | } | ||
98 | buf.push('</select>'); | ||
99 | return buf.join(''); | ||
100 | } | ||
101 | |||
102 | function navigate_to_first_existing(urls) { | ||
103 | // Navigate to the first existing URL in urls. | ||
104 | var url = urls.shift(); | ||
105 | |||
106 | // Web browsers won't redirect file:// urls to file urls using ajax but | ||
107 | // its useful for local testing | ||
108 | if (url.startsWith("file://")) { | ||
109 | window.location.href = url; | ||
110 | return; | ||
111 | } | ||
112 | |||
113 | if (urls.length == 0) { | ||
114 | window.location.href = url; | ||
115 | return; | ||
116 | } | ||
117 | $.ajax({ | ||
118 | url: url, | ||
119 | success: function() { | ||
120 | window.location.href = url; | ||
121 | }, | ||
122 | error: function() { | ||
123 | navigate_to_first_existing(urls); | ||
124 | } | ||
125 | }); | ||
126 | } | ||
127 | |||
128 | function get_docroot_url() { | ||
129 | var url = window.location.href; | ||
130 | var root = DOCUMENTATION_OPTIONS.URL_ROOT; | ||
131 | |||
132 | var urlarray = url.split('/'); | ||
133 | // Trim off anything after '/' | ||
134 | urlarray.pop(); | ||
135 | var depth = (root.match(/\.\.\//g) || []).length; | ||
136 | for (var i = 0; i < depth; i++) { | ||
137 | urlarray.pop(); | ||
138 | } | ||
139 | |||
140 | return urlarray.join('/') + '/'; | ||
141 | } | ||
142 | |||
143 | function on_version_switch() { | ||
144 | var selected_version = $(this).children('option:selected').attr('value'); | ||
145 | var url = window.location.href; | ||
146 | var current_version = DOCUMENTATION_OPTIONS.VERSION; | ||
147 | var docroot = get_docroot_url() | ||
148 | |||
149 | var new_versionpath = selected_version + '/'; | ||
150 | if (selected_version == "dev") | ||
151 | new_versionpath = ''; | ||
152 | |||
153 | // dev versions have no version prefix | ||
154 | if (current_version == "dev") { | ||
155 | var new_url = docroot + new_versionpath + url.replace(docroot, ""); | ||
156 | var fallback_url = docroot + new_versionpath; | ||
157 | } else { | ||
158 | var new_url = url.replace('/' + current_version + '/', '/' + new_versionpath); | ||
159 | var fallback_url = new_url.replace(url.replace(docroot, ""), ""); | ||
160 | } | ||
161 | |||
162 | console.log(get_docroot_url()) | ||
163 | console.log(url + " to url " + new_url); | ||
164 | console.log(url + " to fallback " + fallback_url); | ||
165 | |||
166 | if (new_url != url) { | ||
167 | navigate_to_first_existing([ | ||
168 | new_url, | ||
169 | fallback_url, | ||
170 | 'https://www.yoctoproject.org/docs/', | ||
171 | ]); | ||
172 | } | ||
173 | } | ||
174 | |||
175 | function on_doctype_switch() { | ||
176 | var selected_doctype = $(this).children('option:selected').attr('value'); | ||
177 | var url = window.location.href; | ||
178 | if (selected_doctype == 'mega') { | ||
179 | var docroot = get_docroot_url() | ||
180 | var current_version = DOCUMENTATION_OPTIONS.VERSION; | ||
181 | // Assume manuals before 3.2 are using old docbook mega-manual | ||
182 | if (ver_compare(current_version, "3.2") < 0) { | ||
183 | var new_url = docroot + "mega-manual/mega-manual.html"; | ||
184 | } else { | ||
185 | var new_url = docroot + "singleindex.html"; | ||
186 | } | ||
187 | } else { | ||
188 | var new_url = url.replace("singleindex.html", "index.html") | ||
189 | } | ||
190 | |||
191 | if (new_url != url) { | ||
192 | navigate_to_first_existing([ | ||
193 | new_url, | ||
194 | 'https://www.yoctoproject.org/docs/', | ||
195 | ]); | ||
196 | } | ||
197 | } | ||
198 | |||
199 | // Returns the current doctype based upon the url | ||
200 | function doctype_segment_from_url(url) { | ||
201 | if (url.includes("singleindex") || url.includes("mega-manual")) | ||
202 | return "mega"; | ||
203 | return "single"; | ||
204 | } | ||
205 | |||
206 | $(document).ready(function() { | ||
207 | var release = DOCUMENTATION_OPTIONS.VERSION; | ||
208 | var current_doctype = doctype_segment_from_url(window.location.href); | ||
209 | var current_series = release.substr(0, 3); | ||
210 | var version_select = build_version_select(current_series, release); | ||
211 | |||
212 | $('.version_switcher_placeholder').html(version_select); | ||
213 | $('.version_switcher_placeholder select').bind('change', on_version_switch); | ||
214 | |||
215 | var doctype_select = build_doctype_select(current_doctype); | ||
216 | |||
217 | $('.doctype_switcher_placeholder').html(doctype_select); | ||
218 | $('.doctype_switcher_placeholder select').bind('change', on_doctype_switch); | ||
219 | |||
220 | if (ver_compare(release, "3.1") < 0) { | ||
221 | $('#outdated-warning').html('Version ' + release + ' of the project is now considered obsolete, please select and use a more recent version'); | ||
222 | $('#outdated-warning').css('padding', '.5em'); | ||
223 | } else if (release != "dev") { | ||
224 | $.each(all_versions, function(version, title) { | ||
225 | var series = version.substr(0, 3); | ||
226 | if (series == current_series && version != release) { | ||
227 | $('#outdated-warning').html('This document is for outdated version ' + release + ', you should select the latest release version in this series, ' + version + '.'); | ||
228 | $('#outdated-warning').css('padding', '.5em'); | ||
229 | } | ||
230 | }); | ||
231 | } | ||
232 | }); | ||
233 | })(); | ||