|
1 <#-- |
|
2 ============================================================================ |
|
3 Name : documentation.rst.ftl |
|
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 .. index:: |
|
23 module: Documentation |
|
24 |
|
25 ################### |
|
26 Documentation |
|
27 ################### |
|
28 |
|
29 |
|
30 .. contents:: |
|
31 |
|
32 |
|
33 APIs |
|
34 ==== |
|
35 |
|
36 * `Search API`_ |
|
37 |
|
38 .. _`Search API`: ../api/index.html |
|
39 |
|
40 * `Helium API`_ |
|
41 |
|
42 The `Helium API`_ specifies all the available Ant_ targets and their |
|
43 required properties. The API is the number one resource to use when |
|
44 building up a Helium configuration. |
|
45 |
|
46 .. _`Helium API`: ../api/helium/index.html |
|
47 .. _Ant: http://ant.apache.org |
|
48 |
|
49 * `Helium Antlib`_ |
|
50 |
|
51 .. _`Helium Antlib`: ../helium-antlib/index.html |
|
52 |
|
53 * `Ant Tasks`_ |
|
54 |
|
55 .. _`Ant Tasks`: ../api/ant/index.html |
|
56 |
|
57 <#if !(ant?keys?seq_contains("sf"))> |
|
58 Customer APIs |
|
59 ------------- |
|
60 |
|
61 * `IDO API`_ |
|
62 * `DFS70501 API`_ |
|
63 |
|
64 .. _`IDO API`: ../ido/api/helium/index.html |
|
65 .. _`DFS70501 API`: ../dfs70501/api/helium/index.html |
|
66 </#if> |
|
67 |
|
68 Building custom documentation |
|
69 ============================= |
|
70 |
|
71 Documentation for any Helium configuration can be built using ``hlm docs``. The paths to RST documentation source directories must be defined using either a property for a single path or a resources element for multiple paths:: |
|
72 |
|
73 <property name="doc.src.dir" location="basedir_path/docs/src" /> |
|
74 |
|
75 <resources id="textdoc.paths"> |
|
76 <path> |
|
77 <pathelement path="basedir_path/docs/src"/> |
|
78 <pathelement path="basedir_path/docs/src2"/> |
|
79 </path> |
|
80 </resources> |
|
81 |
|
82 |
|
83 |