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

<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc-module.html" target="_top">no frames</a>]</font></td></tr>

</table></td>

</tr></table>

<h2 class="package">Package epydoc</h2>

Automatic Python reference documentation generator. Epydoc processes

Python modules and docstrings to generate formatted API documentation, in

the form of HTML pages. Epydoc can be used via a command-line interface

(<a href="epydoc.cli-module.html"

class="link"><code>epydoc.cli</code></a>) and a graphical interface (<a

href="epydoc.gui-module.html" class="link"><code>epydoc.gui</code></a>).

Both interfaces let the user specify a set of modules to document, and

produce API documentation using the following steps:

<li>

Import the requested modules, using <a

href="epydoc.imports-module.html"

class="link"><code>epydoc.imports</code></a>.

</li>

<li>

Construct documentation for each object, using <a

href="epydoc.objdoc-module.html"

class="link"><code>epydoc.objdoc</code></a>.

<ul>

<li>

<a href="epydoc.uid-module.html"

class="link"><code>epydoc.uid</code></a> is used to create unique

identifiers for each object.

</li>

<li>

The <a href="epydoc.markup-module.html"

class="link"><code>epydoc.markup</code></a> package is used to

parse the objects' documentation strings.

</li>

</ul>

</li>

<li>

Generate output, using <a href="epydoc.html-module.html"

class="link"><code>epydoc.html</code></a> or <a

href="epydoc.latex-module.html"

class="link"><code>epydoc.latex</code></a>.

<ul>

<li>

<a href="epydoc.css-module.html"

class="link"><code>epydoc.css</code></a> is used to generate the

CSS stylehseet for HTML output.

</li>

<li>

<a href="epydoc.help-module.html"

class="link"><code>epydoc.help</code></a> is used to generate the

help page for HTML output.

</li>

<li>

<a href="epydoc.colorize-module.html"

class="link"><code>epydoc.colorize</code></a> is used to colorize

doctest blocks and regular expressions variable values for HTML

output.

</li>

</ul>

</li>

</ol>

100

<hr/>

101

<p><b>Version:</b> 2.1

102

</p>

103

104

<p><b>Author:</b> <a href="mailto:edloper@gradient.cis.upenn.edu">Edward

105

Loper</a>

106

</p>

107

108

109

</p>

110

111

<p><b>License:</b> IBM Open Source License

112

</p>

113

114

<p><b>Requires:</b> Python 2.1+, or Python 2.0 with <a

115

href="http://lfw.org/python/inspect.html"><code>inspect.py</code></a>.

116

</p>

117

118

119

<dd>

120

<a href="http://epydoc.sourceforge.net">The epydoc webpage</a>,

121

<a href="http://epydoc.sourceforge.net/epytext.html">The epytext

122

markup language manual</a>

123

</dd>

124

</dl>

125

126

<p><b>To Do:</b> Consider other names for <code>@undocumented</code>:

127

<code>@bypass</code>, <code>@nodoc</code>,

128

<code>@exclude</code>, <code>@omit</code>?

129

</p>

130

131

<p><b>To Do for Version 3.0:</b>

132

<ul>

133

<li>Support encodings.

134

</li>

135

<li>Refactor <a href="epydoc.objdoc.ObjDoc-class.html"

136

class="link"><code>epydoc.objdoc.ObjDoc</code></a>:

137

<ul>

138

<li>

139

<code>ObjDoc</code>s will contain info about objects, but not

140

gather it.

141

</li>

142

<li>

143

An <code>inspection</code> module will gather info via

144

inspection.

145

</li>

146

<li>

147

A new <code>parsing</code> module will provide an alternative,

148

gathering info by parsing python files.

149

</li>

150

<li>

151

<code>Var</code> will be replaced by <code>VarDoc</code>, a

152

subclass of <code>ObjDoc</code>.

153

</li>

154

<li>

155

Structure <code>ObjDoc</code>s in a directed acyclic graph, rather

156

than using a links and a dictionary? Are non-directed cycles a

157

problem? Interaction of the access hierarchy (a.b.c) and the base

158

class hierarchy? What does pydoc do?

159

</li>

160

</ul>

161

</li>

162

<li>Create a better default top_page than trees.html.

163

</li>

164

<li>Add the man-page style outputter. (epyman)

165

</li>

166

<li>Docstring inheritance for overridden properties.

167

</li>

168

<li>Optimize epytext

169

<ul>

170

<li>

171

Use classes instead of minidom nodes?

172

</li>

173

</ul>

174

</li>

175

<li>Rewrite <code>epydoc.uid.findUID</code> to be more robust.

176

177

</li>

178

</ul></p>

179

180

<p><b>Contributors (Alphabetical Order):</b>

181

<ul>

182

<li><a href="mailto:glyph@twistedmatrix.com">Glyph Lefkowitz</a>

183

</li>

184

<li><a href="mailto:edloper@gradient.cis.upenn.edu">Edward

185

Loper</a>

186

</li>

187

<li><a href="mailto:bruce@cubik.org">Bruce Mitchener</a>

188

</li>

189

<li><a href="mailto:spamies@bipbap.de">Simon Pamies</a>

190

</li>

191

<li><a href="mailto:kiko@async.com.br">Christian Reis</a>

192

</li>

193

<li><a href="mailto:jeff@ohalloran.ca">Jeff O'Halloran</a>

194

195

</li>

196

</ul></p>

197

198

199

200

201

202

<th colspan="2">Submodules</th></tr>

203

204

205

</ul></td></tr>

206

207

<th colspan="2">    Interface Modules</th></tr>

208

209

<li> <b><a href="epydoc.cli-module.html"><code>cli</code></a></b>: <i>Command-line interface for epydoc.</i>

210

<li> <b><a href="epydoc.gui-module.html"><code>gui</code></a></b>: <i>Graphical interface to epydoc.</i>

211

</ul></td></tr>

212

213

<th colspan="2">    Inspection Modules</th></tr>

214

215

<li> <b><a href="epydoc.uid-module.html"><code>uid</code></a></b>: <i>Unique identifiers and crossreference links for Python objects.</i>

216

<li> <b><a href="epydoc.objdoc-module.html"><code>objdoc</code></a></b>: <i>Support for <code>ObjDoc</code>s, which encode the information about a

217

Python object that is necessary to create its documentation.</i>

218

<li> <b><a href="epydoc.imports-module.html"><code>imports</code></a></b>: <i>Module import support for epydoc.</i>

219

</ul></td></tr>

220

221

<th colspan="2">    Docstring Parsing Modules</th></tr>

222

223

<li> <b><a href="epydoc.markup-module.html"><code>markup</code></a></b>: <i>Markup language support for docstrings.</i>

224

<ul>

225

<li> <b><a href="epydoc.markup.epytext-module.html"><code>epytext</code></a></b>: <i>Parser for epytext strings.</i>

226

<li> <b><a href="epydoc.markup.javadoc-module.html"><code>javadoc</code></a></b>: <i>Epydoc parser for <a

227

href="http://java.sun.com/j2se/javadoc/">Javadoc</a> docstrings.</i>

228

<li> <b><a href="epydoc.markup.plaintext-module.html"><code>plaintext</code></a></b>: <i>Parser for plaintext docstrings.</i>

229

<li> <b><a href="epydoc.markup.restructuredtext-module.html"><code>restructuredtext</code></a></b>: <i>Epydoc parser for ReStructuredText strings.</i>

230

</ul>

231

</ul></td></tr>

232

233

<th colspan="2">    Documentation Output Modules</th></tr>

234

235

<li> <b><a href="epydoc.html-module.html"><code>html</code></a></b>: <i>Documentation to HTML converter.</i>

236

<li> <b><a href="epydoc.css-module.html"><code>css</code></a></b>: <i>Predefined CSS stylesheets for the HTML outputter (<a

237

href="epydoc.html-module.html"

238

class="link"><code>epydoc.html</code></a>).</i>

239

<li> <b><a href="epydoc.help-module.html"><code>help</code></a></b>: <i>Default help file for the HTML outputter (<a

240

href="epydoc.html-module.html"

241

class="link"><code>epydoc.html</code></a>).</i>

242

<li> <b><a href="epydoc.colorize-module.html"><code>colorize</code></a></b>: <i>Functions to produce colorized HTML code for various objects.</i>

243

<li> <b><a href="epydoc.latex-module.html"><code>latex</code></a></b>: <i>Documentation to LaTeX converter.</i>

244

<li> <b><a href="epydoc.man-module.html"><code>man</code></a></b>: <i>Documentation formatter that produces man-style documentation.</i>

245

</ul></td></tr>

246

247

<th colspan="2">    Testing Modules</th></tr>

248

249

<li> <b><a href="epydoc.checker-module.html"><code>checker</code></a></b>: <i>Documentation completeness checker.</i>

250

<li> <b><a href="epydoc.test-module.html"><code>test</code></a></b>: <i>Unit tests for the NLTK modules.</i>

251

<ul>

252

<li> <b><a href="epydoc.test.epytext-module.html"><code>epytext</code></a></b>: <i>Regression testing for the epytext markup language.</i>

253

</ul>

254

</ul></td></tr>

255

</table><br />

256

257

258

259

260

261

<th colspan="2">Variable Summary</th></tr>

262

263

<td><b><a href="epydoc-module.html#__author__"><code>__author__</code></a></b> = <span title="'Edward Loper <edloper@gradient.cis.upenn.edu>'"><code><span class="variable-quote">'</span>Edward Loper <edloper@gradient.cis.upenn.e<span class="variable-ellipsis">...</span></code>

264

</span></td></tr>

265

266

<td><b><a href="epydoc-module.html#__license__"><code>__license__</code></a></b>: The license governing the use and distribution of epydoc.</td></tr>

267

268

<td><b><a href="epydoc-module.html#__url__"><code>__url__</code></a></b> = <span title="'http://epydoc.sourceforge.net'"><code><span class="variable-quote">'</span>http://epydoc.sourceforge.net<span class="variable-quote">'</span> </code>

269

</span></td></tr>

270

271

<td><b><a href="epydoc-module.html#__version__"><code>__version__</code></a></b> = <span title="'2.1'"><code><span class="variable-quote">'</span>2.1<span class="variable-quote">'</span> </code>

272

</span></td></tr>

273

</table><br />

274

275

276

277

278

279

<th colspan="2">Variable Details</th></tr>

280

</table>

281

282

283

<h3>__author__</h3>

284

<dl>

285

286

<dd>

287

<dl>

288

289

<dd>

290

291

292

</dd>

293

<span title="'Edward Loper <edloper@gradient.cis.upenn.edu>'"> <dt><b>Value:</b></dt>

294

295

296

<span class="variable-quote">'</span>Edward Loper <edloper@gradient.cis.upenn.edu><span class="variable-quote">'</span> </pre>

297

</td></tr></table></dd>

298

</span> </dl>

299

</dd>

300

</dl></td></tr></table>

301

302

303

<h3>__license__</h3>

304

The license governing the use and distribution of epydoc.

305

<dl>

306

307

<dd>

308

<dl>

309

310

<dd>

311

312

313

</dd>

314

<span title="'IBM Open Source License'"> <dt><b>Value:</b></dt>

315

316

317

<span class="variable-quote">'</span>IBM Open Source License<span class="variable-quote">'</span> </pre>

318

</td></tr></table></dd>

319

</span> </dl>

320

</dd>

321

</dl></td></tr></table>

322

323

324

325

<dl>

326

327

<dd>

328

<dl>

329

330

<dd>

331

332

333

</dd>

334

<span title="'http://epydoc.sourceforge.net'"> <dt><b>Value:</b></dt>

335

336

337

<span class="variable-quote">'</span>http://epydoc.sourceforge.net<span class="variable-quote">'</span> </pre>

338

</td></tr></table></dd>

339

</span> </dl>

340

</dd>

341

</dl></td></tr></table>

342

343

344

<h3>__version__</h3>

345

<dl>

346

347

<dd>

348

<dl>

349

350

<dd>

351

352

353

</dd>

354

<span title="'2.1'"> <dt><b>Value:</b></dt>

355

356

357

358

</td></tr></table></dd>

359

</span> </dl>

360

</dd>

361

</dl></td></tr></table>

362

<br />

363

364

365

366

367

368

369

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

370

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

371

372

373

374

375

376

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

377

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

378

</th>

379

</tr>

380

</table>

381

382

383

<tr>

384

<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:19 2004</font></td>

385

<td align="right"><a href="http://epydoc.sourceforge.net"

386

><font size="-2">http://epydoc.sf.net</font></a></td>

387

</tr>

388

</table>

389

</body>

390

</html>

Older »