~ubuntu-branches/debian/lenny/epydoc/lenny

<h1 class="epydoc">Module html</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html">source code</a></span></p>

<p>The HTML output generator for epydoc. The main interface provided by

this module is the <a href="epydoc.docwriter.html.HTMLWriter-class.html"

class="link">HTMLWriter</a> class.</p>

<hr />

Add a cache to <a

href="epydoc.docwriter.html.HTMLWriter-class.html#url"

class="link">HTMLWriter.url()</a>?

</p>

</div>

<table class="summary" border="1" cellpadding="3"

cellspacing="0" width="100%" bgcolor="white">

<td align="left"><span class="table-header">Classes</span></td>

<td align="right" valign="top"

><span class="options">[<a href="#section-Classes"

class="privatelink" onclick="toggle_private();"

>hide private</a>]</span></td>

</tr>

</table>

</td>

</tr>

<tr>

</td><td class="summary">

<a href="epydoc.docwriter.html.HTMLWriter-class.html" class="summary-name">HTMLWriter</a>

</td>

</tr>

100

101

102

</td><td class="summary">

103

<a href="epydoc.docwriter.html._HTMLDocstringLinker-class.html" class="summary-name" onclick="show_private();">_HTMLDocstringLinker</a>

104

</td>

105

</tr>

106

</table>

107

108

109

<table class="summary" border="1" cellpadding="3"

110

cellspacing="0" width="100%" bgcolor="white">

111

112

113

114

115

<td align="left"><span class="table-header">Functions</span></td>

116

<td align="right" valign="top"

117

><span class="options">[<a href="#section-Functions"

118

class="privatelink" onclick="toggle_private();"

119

>hide private</a>]</span></td>

120

</tr>

121

</table>

122

</td>

123

</tr>

124

<tr>

125

126

127

</td><td class="summary">

128

129

<tr>

130

<td><span class="summary-sig"><a href="epydoc.docwriter.html-module.html#compile_template" class="summary-sig-name">compile_template</a>(<span class="summary-sig-arg">docstring</span>,

131

<span class="summary-sig-arg">template_string</span>,

132

<span class="summary-sig-arg">output_function</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">out</code><code class="variable-quote">'</code></span>,

133

<span class="summary-sig-arg">debug</span>=<span class="summary-sig-default">True</span>)</span><br />

134

Given a template string containing inline python source code, return

135

a python function that will fill in the template, and output the

136

result.</td>

137

138

<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#compile_template">source code</a></span>

139

<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_compile_templat-summary-div');return false;">call graph</a></span> 

140

</td>

141

</tr>

142

</table>

143

144

145

146

147

148

</map>

149

150

</center></td></tr>

151

<tr><th>Call Graph</th></tr>

152

</table><br />

153

</center></div>

154

155

</td>

156

</tr>

157

<tr>

158

159

160

</td><td class="summary">

161

162

<tr>

163

<td><span class="summary-sig"><a name="strip_indent"></a><span class="summary-sig-name">strip_indent</span>(<span class="summary-sig-arg">s</span>)</span><br />

164

Given a multiline string <code>s</code>, find the minimum indentation

165

for all non-blank lines, and return a new string formed by stripping

166

that amount of indentation from all lines in <code>s</code>.</td>

167

168

<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#strip_indent">source code</a></span>

169

<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_strip_indent-summary-div');return false;">call graph</a></span> 

170

</td>

171

</tr>

172

</table>

173

174

175

176

177

178

</map>

179

180

</center></td></tr>

181

<tr><th>Call Graph</th></tr>

182

</table><br />

183

</center></div>

184

185

</td>

186

</tr>

187

</table>

188

189

190

<table class="details" border="1" cellpadding="3"

191

cellspacing="0" width="100%" bgcolor="white">

192

193

194

195

196

<td align="left"><span class="table-header">Function Details</span></td>

197

<td align="right" valign="top"

198

><span class="options">[<a href="#section-FunctionDetails"

199

class="privatelink" onclick="toggle_private();"

200

>hide private</a>]</span></td>

201

</tr>

202

</table>

203

</td>

204

</tr>

205

</table>

206

207

<div>

208

<table class="details" border="1" cellpadding="3"

209

cellspacing="0" width="100%" bgcolor="white">

210

211

212

213

<h3 class="epydoc"><span class="sig"><span class="sig-name">compile_template</span>(<span class="sig-arg">docstring</span>,

214

<span class="sig-arg">template_string</span>,

215

<span class="sig-arg">output_function</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">out</code><code class="variable-quote">'</code></span>,

216

<span class="sig-arg">debug</span>=<span class="sig-default">True</span>)</span>

217

</h3>

218

</td><td align="right" valign="top"

219

><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#compile_template">source code</a></span> 

220

<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_compile_templat-div');return false;">call graph</a></span> </td>

221

</tr></table>

222

223

224

225

226

227

</map>

228

229

</center></td></tr>

230

<tr><th>Call Graph</th></tr>

231

</table><br />

232

</center></div>

233

234

<p>Given a template string containing inline python source code, return a

235

python function that will fill in the template, and output the result.

236

The signature for this function is taken from the first line of

237

<code>docstring</code>. Output is generated by making repeated calls to

238

the output function with the given name (which is typically one of the

239

function's parameters).</p>

240

<p>The templating language used by this function passes through all text

241

as-is, with three exceptions:</p>

242

<ul>

243

<li>

244

If every line in the template string is indented by at least <i

245

class="math">x</i> spaces, then the first <i class="math">x</i>

246

spaces are stripped from each line.

247

</li>

248

<li>

249

Any line that begins with '>>>' (with no indentation) should

250

contain python code, and will be inserted as-is into the

251

template-filling function. If the line begins a control block (such

252

as 'if' or 'for'), then the control block will be closed by the first

253

'>>>'-marked line whose indentation is less than or equal to

254

the line's own indentation (including lines that only contain

255

comments.)

256

</li>

257

<li>

258

In any other line, any expression between two '$' signs will be

259

evaluated and inserted into the line (using <code>str()</code> to

260

convert the result to a string).

261

</li>

262

</ul>

263

<p>Here is a simple example:</p>

264

265

<span class="py-prompt">>>> </span>TEMPLATE = <span class="py-string">''</span>'

266

267

<span class="py-more">... </span> <title>$book.title$</title>

268

<span class="py-more">... </span> <pages>$book.count_pages()$</pages>

269

<span class="py-more">... </span>>>> <span class="py-keyword">for</span> chapter <span class="py-keyword">in</span> book.chapters:

270

<span class="py-more">... </span> <chaptername>$chapter.name$</chaptername>

271

<span class="py-more">... </span>>>> <span class="py-comment">#endfor</span>

272

273

<span class="py-prompt">>>> </span>write_book = compile_template(<span class="py-string">'write_book(out, book)'</span>, TEMPLATE)</pre>

274

275

</dl>

276

<div class="fields"> <p><strong>Acknowledgements:</strong>

277

The syntax used by <code>compile_template</code> is loosely based

278

on Cheetah.

279

</p>

280

</div></td></tr></table>

281

</div>

282

<br />

283

284

<table class="navbar" border="0" width="100%" cellpadding="0"

285

bgcolor="#a0c0ff" cellspacing="0">

286

287

288

<th>   <a

289

href="epydoc-module.html">Home</a>   </th>

290

291

292

<th>   <a

293

href="module-tree.html">Trees</a>   </th>

294

295

296

<th>   <a

297

href="identifier-index.html">Indices</a>   </th>

298

299

300

<th>   <a

301

href="help.html">Help</a>   </th>

302

303

304

305

306

<tr><th class="navbar" align="center"

307

><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>

308

</tr></table></th>

309

</tr>

310

</table>

311

312

<tr>

313

314

<a href="epydoc-log.html">Generated by Epydoc

315

3.0.1 on Wed Jan 30 14:06:37 2008</a>

316

</td>

317

318

<a target="mainFrame" href="http://epydoc.sourceforge.net"

319

>http://epydoc.sourceforge.net</a>

320

</td>

321

</tr>

322

</table>

323

324

325

<!--

326

// Private objects are initially displayed (because if

327

// javascript is turned off then we want them to be

328

// visible); but by default, we want to hide them. So hide

329

// them unless we have a cookie that says to show them.

330

checkCookie();

331

// -->

332

</script>

333

</body>

334

</html>

Older »