author | wbernard |
Tue, 27 Apr 2010 08:33:08 +0300 | |
changeset 587 | 85df38eb4012 |
parent 217 | 0f5e3a7fb6af |
child 588 | c7c26511138f |
permissions | -rw-r--r-- |
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
1 |
<?xml version="1.0" encoding="UTF-8"?> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
2 |
<!-- |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
3 |
============================================================================ |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
4 |
Name : docs.ant.xml |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
5 |
Part of : Helium |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
6 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
7 |
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
8 |
All rights reserved. |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
9 |
This component and the accompanying materials are made available |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
10 |
under the terms of the License "Eclipse Public License v1.0" |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
11 |
which accompanies this distribution, and is available |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
12 |
at the URL "http://www.eclipse.org/legal/epl-v10.html". |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
13 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
14 |
Initial Contributors: |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
15 |
Nokia Corporation - initial contribution. |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
16 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
17 |
Contributors: |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
18 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
19 |
Description: |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
20 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
21 |
============================================================================ |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
22 |
--> |
217 | 23 |
<!--* @package framework --> |
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
24 |
<project name="internal.docs" xmlns:hlm="http://www.nokia.com/helium" xmlns:ivy="antlib:org.apache.ivy.ant"> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
25 |
<description> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
26 |
Documentation generation targets. |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
27 |
</description> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
28 |
|
217 | 29 |
<!-- Location of documentation source. |
587 | 30 |
This is set to work with IDO docs, to avoid updating their config. |
217 | 31 |
@type string |
32 |
@scope public |
|
33 |
--> |
|
587 | 34 |
<property name="doc.src.dir" location="${basedir}/docs/src" /> |
35 |
<!-- Location of documentation API source. |
|
36 |
@type string |
|
37 |
@scope private |
|
38 |
--> |
|
39 |
<property name="api.doc.src.dir" location="${helium.dir}/doc/api" /> |
|
40 |
||
41 |
<!-- A list of source paths for RST documentation to be built. --> |
|
42 |
<resources id="textdoc.paths"> |
|
43 |
<path> |
|
44 |
<pathelement path="${doc.src.dir}"/> |
|
45 |
</path> |
|
46 |
</resources> |
|
217 | 47 |
|
48 |
<!-- The location where the docs will be built. |
|
49 |
@type string |
|
50 |
@scope private --> |
|
587 | 51 |
<property name="doc.build.dir" location="${basedir}/build/doc" /> |
52 |
<!-- A temp location for doc processing. |
|
53 |
@type string |
|
54 |
@scope private --> |
|
55 |
<property name="doc.temp.dir" location="${basedir}/build/temp/doc" /> |
|
56 |
<!-- A temp location for doc processing. |
|
57 |
@type string |
|
58 |
@scope private --> |
|
59 |
<property name="doc_search.temp.dir" location="${basedir}/build/temp/doc_search" /> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
60 |
|
217 | 61 |
<fileset id="static.doc.files" dir="${helium.dir}/doc/src"> |
62 |
<include name="conf.py"/> |
|
63 |
<include name=".static"/> |
|
64 |
<include name=".templates/**"/> |
|
65 |
<include name="*.jpg"/> |
|
66 |
<include name="*.css"/> |
|
67 |
</fileset> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
68 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
69 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
70 |
<!-- Cleans the Helium API documentation. --> |
217 | 71 |
<target name="clean-helium-apidocs"> |
587 | 72 |
<delete dir="${doc.build.dir}/api/helium"/> |
73 |
<delete dir="${doc.temp.dir}/api/helium"/> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
74 |
</target> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
75 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
76 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
77 |
<!-- Creates images of the dependencies for all Ant targets. |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
78 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
79 |
This includes creating a cmap file that is included in the HTML document, |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
80 |
so the boxes in the image are linked to their targets. --> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
81 |
<target name="helium-api-dependency-images"> |
587 | 82 |
<mkdir dir="${doc.build.dir}/api/helium"/> |
83 |
<mkdir dir="${doc.temp.dir}/api/helium"/> |
|
84 |
<fmpp sourceRoot="${api.doc.src.dir}" includes="*.dot.ftl" outputRoot="${doc.temp.dir}/api/helium" |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
85 |
replaceExtension="dot.ftl, dot"> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
86 |
<data expandProperties="yes"> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
87 |
doc: xml(${database.file}) |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
88 |
</data> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
89 |
</fmpp> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
90 |
<for param="dot.file" parallel="true" threadCount="${number.of.threads}"> |
587 | 91 |
<fileset dir="${doc.temp.dir}/api/helium" includes="*.dot"/> |
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
92 |
<sequential> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
93 |
<echo>Processing dot file: @{dot.file}</echo> |
587 | 94 |
<exec executable="dot" dir="${doc.temp.dir}/api/helium"> |
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
95 |
<arg line="-Tcmap @{dot.file} -O"/> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
96 |
</exec> |
587 | 97 |
<exec executable="dot" dir="${doc.build.dir}/api"> |
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
98 |
<arg line="-Tpng @{dot.file} -O"/> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
99 |
</exec> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
100 |
</sequential> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
101 |
</for> |
587 | 102 |
<move todir="${doc.build.dir}/api/helium" overwrite="true"> |
103 |
<fileset dir="${doc.temp.dir}/api/helium" includes="*.dot.png"/> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
104 |
</move> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
105 |
</target> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
106 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
107 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
108 |
<!-- Builds the HTML files for the Helium API documentation. --> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
109 |
<target name="helium-api-html-docs"> |
587 | 110 |
<mkdir dir="${doc.build.dir}/api/helium"/> |
111 |
<copy todir="${doc.temp.dir}/api/helium" overwrite="true"> |
|
112 |
<fileset dir="${api.doc.src.dir}"/> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
113 |
</copy> |
587 | 114 |
<fmpp sourceRoot="${doc.temp.dir}/api/helium" excludes="*.dot.png,*.dot.ftl,**/*.dot,**/*.cmap,*.bak" |
115 |
outputRoot="${doc.build.dir}/api/helium" |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
116 |
replaceExtension="html.ftl, html"> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
117 |
<data expandProperties="yes"> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
118 |
ant: antProperties() |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
119 |
doc: xml(${database.file}) |
587 | 120 |
</data> |
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
121 |
</fmpp> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
122 |
</target> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
123 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
124 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
125 |
<!-- Builds the Helium API documentation. --> |
217 | 126 |
<target name="helium-apidocs" depends="clean-helium-apidocs,database, |
127 |
helium-api-dependency-images,helium-api-html-docs"/> |
|
128 |
||
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
129 |
|
217 | 130 |
<!-- Generate API documentation from the source code. --> |
131 |
<target name="apidocs" depends="helium-apidocs,apidocs-search"/> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
132 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
133 |
|
217 | 134 |
<!-- Macro to generate HTML docs from rst. --> |
587 | 135 |
<macrodef name="rstPrepMacro" uri="http://www.nokia.com/helium"> |
136 |
<attribute name="destdir"/> |
|
137 |
<element name="resources-elements" implicit="yes"/> |
|
138 |
<sequential> |
|
139 |
<for param="dir"> |
|
140 |
<resources-elements/> |
|
141 |
<sequential> |
|
142 |
<echo>Copying textdocs source directory: @{dir}</echo> |
|
143 |
<fmpp sourceRoot="@{dir}" |
|
144 |
outputRoot="@{destdir}" removeExtensions="ftl" |
|
145 |
modes="copy(**/*.rst, **/*.html)"> |
|
146 |
<data expandProperties="yes"> |
|
147 |
ant: antProperties() |
|
148 |
project: antProject() |
|
149 |
</data> |
|
150 |
</fmpp> |
|
151 |
</sequential> |
|
152 |
</for> |
|
153 |
</sequential> |
|
154 |
</macrodef> |
|
155 |
||
156 |
||
157 |
<!-- Macro to generate HTML docs from rst. --> |
|
217 | 158 |
<macrodef name="rstMacro" uri="http://www.nokia.com/helium"> |
159 |
<attribute name="version" default="${helium.version}"/> |
|
587 | 160 |
<attribute name="src" default="${doc.temp.dir}"/> |
161 |
<attribute name="output" default="${doc.build.dir}"/> |
|
217 | 162 |
<sequential> |
163 |
<property name="sphinx.lib.dir" location="${helium.dir}/external/python/lib/common/Sphinx-0.5.1-py2.5.egg/sphinx" /> |
|
164 |
<if> |
|
165 |
<available file="${nokia.python.tools}/sphinxfixsearch.diff"/> |
|
166 |
<then> |
|
167 |
<patch patchfile="${nokia.python.tools}/sphinxfixsearch.diff" originalfile="${sphinx.lib.dir}/search.py"/> |
|
168 |
</then> |
|
169 |
</if> |
|
170 |
<if> |
|
171 |
<resourcecount when="greater" count="0"> |
|
172 |
<fileset dir="@{src}" includes="**/*.rst"/> |
|
173 |
</resourcecount> |
|
174 |
<then> |
|
175 |
<exec executable="python" failonerror="true"> |
|
176 |
<arg file="${python.dir}/common/sphinx-build.py"/> |
|
177 |
<arg value="-b" /> |
|
178 |
<arg value="html" /> |
|
179 |
<arg value="-D" /> |
|
180 |
<arg value="version=@{version}" /> |
|
181 |
<arg value="-D" /> |
|
182 |
<arg value="release=@{version}" /> |
|
183 |
<arg file="@{src}" /> |
|
184 |
<arg file="@{output}" /> |
|
185 |
</exec> |
|
186 |
</then> |
|
187 |
</if> |
|
188 |
<if> |
|
189 |
<available file="${nokia.python.tools}/sphinxfixsearch.diff"/> |
|
190 |
<then> |
|
191 |
<patch reverse="true" patchfile="${nokia.python.tools}/sphinxfixsearch.diff" originalfile="${sphinx.lib.dir}/search.py"/> |
|
192 |
</then> |
|
193 |
</if> |
|
194 |
</sequential> |
|
195 |
</macrodef> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
196 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
197 |
|
587 | 198 |
<!-- Generate search index for apis --> |
199 |
<target name="apidocs-search"> |
|
200 |
<echo>Convert API docs to .rst files</echo> |
|
201 |
<hlm:python> |
|
202 |
import html2rest |
|
203 |
import os |
|
204 |
import codecs |
|
205 |
#import traceback |
|
206 |
for root, dirs, files in os.walk(r'${doc.build.dir}/api', topdown=False): |
|
207 |
for fname in files: |
|
208 |
if '.html' in fname: |
|
209 |
filename = os.path.abspath(os.path.join(root, fname)) |
|
210 |
rstfilename = filename.replace('.html', '.rst') |
|
211 |
try: |
|
212 |
out = open(rstfilename, 'w') |
|
213 |
html2rest.html2rest(html2rest.readsoup(filename), out) |
|
214 |
except: |
|
215 |
#traceback.print_exc() |
|
216 |
print filename + ' failed to be converted to rst' |
|
217 |
finally: |
|
218 |
out.close() |
|
219 |
||
220 |
try: |
|
221 |
rstfile = codecs.open(rstfilename, 'r', 'utf8') |
|
222 |
rstfile.read() |
|
223 |
except: |
|
224 |
print rstfilename + ' has invalid unicode' |
|
225 |
rstfile.close() |
|
226 |
os.remove(rstfilename) |
|
227 |
</hlm:python> |
|
228 |
||
229 |
<move todir="${doc_search.temp.dir}" overwrite="true"> |
|
230 |
<fileset dir="${doc.build.dir}/api"> |
|
231 |
<include name="**/*.rst"/> |
|
232 |
</fileset> |
|
233 |
</move> |
|
234 |
||
235 |
<move todir="${doc.build.dir}/api_backup" overwrite="true"> |
|
236 |
<fileset dir="${doc.build.dir}/api"/> |
|
237 |
</move> |
|
238 |
||
239 |
<hlm:rstPrepMacro destdir="${doc_search.temp.dir}"> |
|
240 |
<resources> |
|
241 |
<path> |
|
242 |
<pathelement path="${helium.dir}/doc/default"/> |
|
243 |
</path> |
|
244 |
</resources> |
|
245 |
</hlm:rstPrepMacro> |
|
246 |
||
247 |
<copy file="${api.doc.src.dir}/apisearchindex.rst" tofile="${doc_search.temp.dir}/index.rst" overwrite="true"/> |
|
248 |
||
249 |
<!--<copy todir="${doc_search.temp.dir}"> |
|
250 |
<fileset refid="static.doc.files"/> |
|
251 |
</copy> |
|
252 |
<copy todir="${doc_search.temp.dir}" overwrite="true"> |
|
253 |
<fileset dir="${helium.dir}/doc/src_search" includes="**/*"/> |
|
254 |
</copy>--> |
|
255 |
||
256 |
<hlm:rstMacro src="${doc_search.temp.dir}" output="${doc.build.dir}/api"/> |
|
257 |
||
258 |
<move todir="${doc.build.dir}/api" overwrite="true"> |
|
259 |
<fileset dir="${doc.build.dir}/api_backup"/> |
|
260 |
</move> |
|
261 |
</target> |
|
262 |
||
263 |
||
217 | 264 |
<!-- Generate rst files for docs --> |
265 |
<target name="prep-textdocs"> |
|
587 | 266 |
<echo>Building docs into ${doc.build.dir}.</echo> |
217 | 267 |
|
587 | 268 |
<delete dir="${doc.build.dir}/.doctrees"/> |
269 |
<delete file="${doc.build.dir}/searchindex.json"/> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
270 |
|
587 | 271 |
<resources id="textdoc.all.paths"> |
272 |
<!-- default doc content is always processed first --> |
|
273 |
<path> |
|
274 |
<pathelement path="${helium.dir}/doc/default"/> |
|
275 |
</path> |
|
276 |
<resources refid="textdoc.paths"/> |
|
277 |
</resources> |
|
278 |
<hlm:rstPrepMacro destdir="${doc.temp.dir}"> |
|
279 |
<resources refid="textdoc.all.paths"/> |
|
280 |
</hlm:rstPrepMacro> |
|
281 |
</target> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
282 |
|
587 | 283 |
|
284 |
<target name="build-textdocs-dot-images"> |
|
217 | 285 |
<for param="dot.file"> |
587 | 286 |
<fileset dir="${doc.temp.dir}"> |
287 |
<include name="**/*.dot"/> |
|
288 |
<exclude name="api/helium/**/*.dot"/> |
|
289 |
</fileset> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
290 |
<sequential> |
217 | 291 |
<echo>Building dot file: @{dot.file}</echo> |
292 |
<exec executable="dot"> |
|
293 |
<arg line="-Tpng @{dot.file} -O"/> |
|
294 |
</exec> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
295 |
</sequential> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
296 |
</for> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
297 |
</target> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
298 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
299 |
|
217 | 300 |
<!-- Generate HTML documentation from .rst documents with Sphinx. |
301 |
||
302 |
All doc .rst files should be generated or copied into build/temp/doc before being processed into HTML. |
|
303 |
--> |
|
587 | 304 |
<target name="build-textdocs"> |
217 | 305 |
<hlm:rstMacro /> |
306 |
||
587 | 307 |
<copy file="${database.file}" todir="${doc.build.dir}"/> |
217 | 308 |
</target> |
587 | 309 |
|
310 |
||
311 |
<target name="textdocs" depends="prep-textdocs,build-textdocs-dot-images,build-textdocs"/> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
312 |
|
217 | 313 |
|
587 | 314 |
<!-- Cleans only the RST text docs --> |
315 |
<target name="clean-textdocs"> |
|
316 |
<mkdir dir="${doc.build.dir}"/> |
|
317 |
<mkdir dir="${doc.temp.dir}"/> |
|
318 |
<mkdir dir="${doc_search.temp.dir}"/> |
|
319 |
||
320 |
<delete includeemptydirs="true"> |
|
321 |
<fileset dir="${doc.build.dir}"> |
|
322 |
<include name="**/*"/> |
|
323 |
<exclude name="api/helium/**/*"/> |
|
324 |
</fileset> |
|
325 |
<fileset dir="${doc.temp.dir}"/> |
|
326 |
<fileset dir="${doc_search.temp.dir}"/> |
|
327 |
</delete> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
328 |
</target> |
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
329 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
330 |
|
587 | 331 |
<!-- Cleans all documentation. --> |
332 |
<target name="clean-docs" depends="clean-helium-apidocs,clean-textdocs"/> |
|
333 |
||
334 |
||
217 | 335 |
<!-- generate all the user documentation for helium --> |
336 |
<target name="docs" depends="clean-docs,apidocs,textdocs"/> |
|
1
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
337 |
|
be27ed110b50
Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff
changeset
|
338 |
</project> |