|
1 <#-- |
|
2 ============================================================================ |
|
3 Name : |
|
4 Part of : Helium |
|
5 |
|
6 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
7 All rights reserved. |
|
8 This component and the accompanying materials are made available |
|
9 under the terms of the License "Eclipse Public License v1.0" |
|
10 which accompanies this distribution, and is available |
|
11 at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
12 |
|
13 Initial Contributors: |
|
14 Nokia Corporation - initial contribution. |
|
15 |
|
16 Contributors: |
|
17 |
|
18 Description: |
|
19 |
|
20 ============================================================================ |
|
21 --> |
|
22 .. Helium Documentation documentation master file, created by sphinx-quickstart on Fri May 09 09:49:44 2008. |
|
23 You can adapt this file completely to your liking, but it should at least |
|
24 contain the root `toctree` directive. |
|
25 |
|
26 .. index:: |
|
27 module: Helium Documentation |
|
28 |
|
29 ==================== |
|
30 Helium documentation |
|
31 ==================== |
|
32 |
|
33 .. toctree:: |
|
34 :maxdepth: 1 |
|
35 |
|
36 .. raw:: html |
|
37 |
|
38 <table border="0" cellspacing="0" cellpadding="10"> |
|
39 <tr valign="top"> |
|
40 <td width="50%" style="border-right: 1px solid black"> |
|
41 |
|
42 .. index:: |
|
43 single: Getting Started |
|
44 |
|
45 Getting Started |
|
46 ================ |
|
47 |
|
48 This section contains instructions on how to get started with Helium including where to get it from and how to use it at the very simplest level. |
|
49 <#if !(ant?keys?seq_contains("sf"))> |
|
50 This section also has a link to an elearning that goes through Helium at a very high level. |
|
51 </#if> |
|
52 |
|
53 .. toctree:: |
|
54 :maxdepth: 1 |
|
55 |
|
56 introduction |
|
57 quick_start_guide |
|
58 feature_list |
|
59 user-graph |
|
60 |
|
61 <#if !(ant?keys?seq_contains("sf"))> |
|
62 * Elearning_ |
|
63 |
|
64 .. _Elearning: http://lmp.nokia.com/lms/lang-en/taxonomy/TAX_Search.asp?UserMode=0&SearchStr=helium |
|
65 </#if> |
|
66 |
|
67 .. raw:: html |
|
68 |
|
69 </td><td width="50%"> |
|
70 |
|
71 |
|
72 Tutorials and HOWTOs |
|
73 ===================== |
|
74 This section lists all the available tutorials on Helium and how to configure and use it. |
|
75 |
|
76 .. toctree:: |
|
77 :maxdepth: 1 |
|
78 |
|
79 tutorials/configuration/SimplestConfiguration |
|
80 tutorials/configuration/UseHlmTasksInConfiguration |
|
81 tutorials/rom_image |
|
82 tutorials/qt_build |
|
83 |
|
84 .. raw:: html |
|
85 |
|
86 </td></tr> |
|
87 <tr valign="top"> |
|
88 <td width="50%" style="border-right: 1px solid black" rowspan="2"> |
|
89 |
|
90 .. index:: single: Helium Manual |
|
91 |
|
92 Helium Manual |
|
93 ============== |
|
94 |
|
95 This section contains the details of the various activities that can be performed by Helium, you should look |
|
96 here for specific information about a task or action. |
|
97 |
|
98 .. toctree:: |
|
99 :maxdepth: 1 |
|
100 |
|
101 <#if !ant?keys?seq_contains("sf")> |
|
102 nokia/support |
|
103 nokia/nokia |
|
104 nokia/retrieving |
|
105 </#if> |
|
106 sf |
|
107 manual/running |
|
108 manual/configuring |
|
109 |
|
110 .. raw:: html |
|
111 |
|
112 <script type="text/javascript" language="JavaScript"><!-- |
|
113 function ReverseContentDisplay(d) { |
|
114 if(d.length < 1) { return; } |
|
115 |
|
116 var elem = document.getElementsByTagName('div'); |
|
117 for(var i = 0; i < elem.length; i++) |
|
118 { |
|
119 if(elem[i].style.display == "block" && elem[i] != document.getElementById(d)) { |
|
120 elem[i].style.display = "none"; |
|
121 } |
|
122 } |
|
123 |
|
124 if(document.getElementById(d).style.display == "none") { document.getElementById(d).style.display = "block"; } |
|
125 else { document.getElementById(d).style.display = "none"; } |
|
126 } |
|
127 //--></script> |
|
128 <ul><li class="toctree-l1"><a href="javascript:ReverseContentDisplay('stages')">Stages</a></li></ul> |
|
129 <div id="stages" style="display:none; position:absolute; border-style: solid; background-color: white; padding: 5px;"> |
|
130 |
|
131 .. toctree:: |
|
132 :maxdepth: 2 |
|
133 |
|
134 manual/stages |
|
135 |
|
136 .. raw:: html |
|
137 |
|
138 </div> |
|
139 <#if !ant?keys?seq_contains("sf")> |
|
140 <ul><li class="toctree-l1"><a href="javascript:ReverseContentDisplay('nokiastages')">Nokia Stages</a></li></ul> |
|
141 <div id="nokiastages" style="display:none; position:absolute; border-style: solid; background-color: white; padding: 5px;"> |
|
142 |
|
143 .. toctree:: |
|
144 :maxdepth: 2 |
|
145 |
|
146 nokia/nokiastages |
|
147 |
|
148 .. raw:: html |
|
149 |
|
150 </div> |
|
151 </#if> |
|
152 .. toctree:: |
|
153 :maxdepth: 1 |
|
154 |
|
155 <#if !ant?keys?seq_contains("sf")> |
|
156 nokia/quality |
|
157 </#if> |
|
158 manual/debugging |
|
159 metrics |
|
160 |
|
161 .. raw:: html |
|
162 |
|
163 <ul><li class="toctree-l1"><a href="javascript:ReverseContentDisplay('api')">API</a></li></ul> |
|
164 <div id="api" style="display:none; position:absolute; border-style: solid; background-color: white; padding: 5px;"> |
|
165 |
|
166 * `Helium API`_ |
|
167 * `Helium Antlib`_ |
|
168 * `Ant Tasks`_ |
|
169 |
|
170 .. _`Ant Tasks`: api/ant/index.html |
|
171 .. _`Helium API`: api/helium/index.html |
|
172 .. _`Helium Antlib`: helium-antlib/index.html |
|
173 |
|
174 <#if !(ant?keys?seq_contains("sf"))> |
|
175 * `Python API`_ |
|
176 * `Java API`_ |
|
177 * `IDO API`_ |
|
178 * `DFS70501 API`_ |
|
179 |
|
180 .. _`Python API`: api/python/index.html |
|
181 .. _`Java API`: api/java/index.html |
|
182 .. _`IDO API`: <#if ant['helium.version']?matches("^\\d+\\.0(?:\\.\\d+)?$")>../</#if>ido/api/helium/index.html |
|
183 .. _`DFS70501 API`: dfs70501/api/helium/index.html |
|
184 </#if> |
|
185 |
|
186 .. raw:: html |
|
187 |
|
188 </div> |
|
189 |
|
190 <#if !ant?keys?seq_contains("sf")> |
|
191 .. toctree:: |
|
192 :maxdepth: 1 |
|
193 |
|
194 api_changes |
|
195 nokia/releasenotes |
|
196 </#if> |
|
197 |
|
198 .. raw:: html |
|
199 |
|
200 </td><td> |
|
201 |
|
202 Helium Framework configuration |
|
203 ============================== |
|
204 |
|
205 .. toctree:: |
|
206 :maxdepth: 3 |
|
207 |
|
208 helium-antlib/index |
|
209 |
|
210 .. toctree:: |
|
211 :maxdepth: 1 |
|
212 |
|
213 manual/cruisecontrol |
|
214 |
|
215 <#if !ant?keys?seq_contains("sf")> |
|
216 Customer docs |
|
217 ============= |
|
218 |
|
219 * IDO_ |
|
220 |
|
221 .. _IDO: <#if ant['helium.version']?matches("^\\d+\\.0(?:\\.\\d+)?$")>../</#if>ido |
|
222 |
|
223 * TeamCI_ |
|
224 |
|
225 .. _TeamCI: <#if ant['helium.version']?matches("^\\d+\\.0(?:\\.\\d+)?$")>../</#if>teamci |
|
226 |
|
227 </#if> |
|
228 |
|
229 Helium Architecture |
|
230 =================== |
|
231 |
|
232 This section describes the architecture of Helium. It also contains a link to the style guide to be used for |
|
233 coding conventions. |
|
234 |
|
235 |
|
236 .. toctree:: |
|
237 :maxdepth: 1 |
|
238 |
|
239 architecture |
|
240 |
|
241 .. raw:: html |
|
242 |
|
243 </td></tr> |
|
244 <tr valign="top"><td> |
|
245 |
|
246 Developer Guide |
|
247 ================== |
|
248 This section contains information on how to make changes to Helium either as a tools team developer or an external |
|
249 developer. The 'developer guide' link contains information on the structure of the directories and some important |
|
250 information on how to add libraries and other miscellaneous information. |
|
251 It also contains details on how to test the changes made. |
|
252 |
|
253 .. toctree:: |
|
254 :maxdepth: 1 |
|
255 |
|
256 <#if !ant?keys?seq_contains("sf")> |
|
257 nokia/howto-contribute |
|
258 nokia/legal |
|
259 nokia/testing |
|
260 </#if> |
|
261 developer_guide |
|
262 coding_conventions |
|
263 |
|
264 .. raw:: html |
|
265 |
|
266 </td></tr> |
|
267 </table> |
|
268 |
|
269 Indices and Tables |
|
270 ================== |
|
271 |
|
272 * :ref:`genindex` |
|
273 * :ref:`search` |