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

<tr><td align="right">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.html.HTMLFormatter-class.html" target="_top">no frames</a>]</td></tr>

</table></td>

</tr></table>

<h2 class="class">Class HTMLFormatter</h2>

<hr/>

Documentation to HTML converter. The API documentation produced

<code>HTMLFormatter</code> consists of a set of HTML files. Two

subdirectories are created for the public and private documentation.

Within each subdirectories, every class and module is documented in its

own file. An index file, a trees file, a help file, and a frames-based

table of contents are also created. In particular,

<code>HTMLFormatter</code> generates the following files:

<ul>

<li>

<a name="index-index_html"></a><i

class="indexterm">index.html: The standard entry point for the

documentation. Normally, index.html is a frame index file, which

defines three frames: two frames on the left side of the browser

contain a table of contents, and the main frame on the right side of

the window contains documentation pages. But if the --no-frames

option is used, then index.html will redirect the user to the

project's top page.

</li>

<li>

<a name="index-module_module_html"></a><i

class="indexterm">module-module.html: The API

documentation for a module. module is the complete dotted name

of the module, such as sys or epydoc.epytext.

</li>

<li>

<a name="index-class_class_html"></a><i

class="indexterm">class-class.html: The API documentation

for a class, exception, or type. class is the complete dotted

name of the class, such as epydoc.epytext.Token or

array.ArrayType.

</li>

<li>

<a name="index-trees_html"></a><i

class="indexterm">trees.html: The module and class

hierarchies.

</li>

<li>

<a name="index-indices_html"></a><i

class="indexterm">indices.html The term and identifier

indices.

</li>

<li>

<a name="index-help_html"></a>help.html:

The help page for the project. This page explains how to use and

navigate the webpage produced by epydoc.

</li>

<li>

<a name="index-toc_html"></a>toc.html:

The top-level table of contents page. This page is displayed in the

upper-left frame, and provides links to toc-everything.html and the

toc-module-module.html files. toc.html is not generated if the

--no-frames option is used.

100

</li>

101

<li>

102

<a name="index-toc_everything_html"></a><i

103

class="indexterm">toc-everything.html: The table of contents for

104

the entire project. This page is displayed in the lower-left frame,

105

and provides links to every class, type, exception, function, and

106

variable defined by the project. toc-everything.html is not generated

107

if the --no-frames option is used.

108

</li>

109

<li>

110

<a name="index-toc_module_module_html"></a><i

111

class="indexterm">toc-module-module.html: The table of

112

contents for a module. This page is displayed in the lower-left

113

frame, and provides links to every class, type, exception, function,

114

and variable defined by the module. module is the complete dotted

115

name of the module, such as sys or epydoc.epytext. toc-m-module.html

116

is not generated if the --no-frames option is used.

117

</li>

118

<li>

119

<a name="index-epydoc_css"></a><i

120

class="indexterm">epydoc.css: The CSS stylesheet used to display

121

all HTML pages.

122

</li>

123

</ul>

124

<hr/>

125

126

127

128

129

130

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

131

132

<td><code><a href="epydoc.html.HTMLFormatter-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(self,

133

docmap,

134

**kwargs)</code>

135

136

Construct a new HTML formatter, using the given documentation map.</td></tr>

137

138

<td><code><a href="epydoc.html.HTMLFormatter-class.html#format" class="summary-sig-name"><code>format</code></a>(object,

139

error_stream,

140

show_private,

141

body_only,

142

**options)</code>

143

144

Return a string containing the HTML documentation for the given object. (Static method)

145

</td></tr>

146

147

</td>

148

<td><code><a href="epydoc.html.HTMLFormatter-class.html#num_files" class="summary-sig-name"><code>num_files</code></a>(self)</code>

149

150

Return the number of files that this <code>HTMLFormatter</code> will

151

generate.</td></tr>

152

153

</td>

154

<td><code><a href="epydoc.html.HTMLFormatter-class.html#write" class="summary-sig-name"><code>write</code></a>(self,

155

directory,

156

progress_callback)</code>

157

158

Write the documentation to the given directory.</td></tr>

159

<tr><td align="right" valign="top" width="15%"> <code>string</code>

160

</td>

161

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_base_tree" class="summary-sig-name"><code>_base_tree</code></a>(self,

162

uid,

163

width,

164

postfix)</code>

165

166

Return the HTML code for a class's base tree.</td></tr>

167

<tr><td align="right" valign="top" width="15%"> <code>string</code>

168

</td>

169

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_breadcrumbs" class="summary-sig-name"><code>_breadcrumbs</code></a>(self,

170

uid)</code>

171

172

Return the HTML code for a series of links to the ancestors of

173

174

175

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_descrlist" class="summary-sig-name"><code>_descrlist</code></a>(self,

176

items,

177

singular,

178

plural,

179

short)</code>

180

181

Return the HTML code for a list of description items.</td></tr>

182

<tr><td align="right" valign="top" width="15%"> <a href="epydoc.markup.ParsedDocstring-class.html"

183

class="link"><code>markup.ParsedDocstring</code></a>

184

</td>

185

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_docstring_to_html" class="summary-sig-name"><code>_docstring_to_html</code></a>(self,

186

docstring,

187

uid,

188

indent)</code>

189

190

Return a string containing the HTML encoding for the given

191

<code>ParsedDocstring</code></td></tr>

192

<tr><td align="right" valign="top" width="15%"> <code>boolean</code>

193

</td>

194

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_documented" class="summary-sig-name"><code>_documented</code></a>(self,

195

uid)</code>

196

197

Return true if the given UID is documented by the documentation map for this

198

<code>HTMLFormatter</code>.</td></tr>

199

<tr><td align="right" valign="top" width="15%"> <code>list</code> of <a href="epydoc.uid.UID-class.html"

200

class="link"><code>UID</code></a>

201

</td>

202

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_extract_identifier_index" class="summary-sig-name"><code>_extract_identifier_index</code></a>(self)</code>

203

204

Return a list of the <code>UID</code>s of all objects and variables

205

documented by <code>_docmap</code>.</td></tr>

206

<tr><td align="right" valign="top" width="15%"> <code>list</code> of <code>(string, <a

207

href="epydoc.markup.ParsedDocstring-class.html"

208

class="link"><code>markup.ParsedDocstring</code></a>, list of

209

Link)</code>

210

</td>

211

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_extract_term_index" class="summary-sig-name"><code>_extract_term_index</code></a>(self)</code>

212

213

Extract the set of terms that should be indexed from all documented

214

docstrings.</td></tr>

215

<tr><td align="right" valign="top" width="15%"> <code>string</code>

216

</td>

217

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_find_top_page" class="summary-sig-name"><code>_find_top_page</code></a>(self,

218

pagename)</code>

219

220

Find the top page for the API documentation.</td></tr>

221

<tr><td align="right" valign="top" width="15%"> <a href="epydoc.uid.UID-class.html"

222

class="link"><code>UID</code></a> or <code>None</code>

223

</td>

224

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_find_toplevel" class="summary-sig-name"><code>_find_toplevel</code></a>(self)</code>

225

226

Return the UID of the top-level module or package, or</td></tr>

227

228

</td>

229

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_find_tree_width" class="summary-sig-name"><code>_find_tree_width</code></a>(self,

230

uid)</code>

231

232

Helper function for <a

233

href="../private/epydoc.html.HTMLFormatter-class.html#_base_tree"

234

class="link"><code>_base_tree</code></a>.</td></tr>

235

<tr><td align="right" valign="top" width="15%"> <code>string</code>

236

</td>

237

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_footer" class="summary-sig-name"><code>_footer</code></a>(self)</code>

238

239

Return the HTML code for the footer of a page.</td></tr>

240

<tr><td align="right" valign="top" width="15%"> <code>string</code>

241

</td>

242

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_frames_link" class="summary-sig-name"><code>_frames_link</code></a>(self,

243

where)</code>

244

245

Return hTML code for the frames/noframes selector.</td></tr>

246

247

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_func_details_entry" class="summary-sig-name"><code>_func_details_entry</code></a>(self,

248

function,

249

container)</code>

250

251

Return the HTML code for an entry in the function details section.</td></tr>

252

253

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_func_signature" class="summary-sig-name"><code>_func_signature</code></a>(self,

254

fname,

255

fuid,

256

fdoc,

257

href,

258

show_defaults,

259

css_class)</code>

260

261

Return the HTML code for the function signature of the function with the

262

given name and documentation.</td></tr>

263

264

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_get_index_terms" class="summary-sig-name"><code>_get_index_terms</code></a>(self,

265

parsed_docstring,

266

link,

267

terms,

268

links)</code>

269

270

A helper function for <a

271

href="../private/epydoc.html.HTMLFormatter-class.html#_extract_term_index"

272

class="link"><code>_extract_term_index</code></a>.</td></tr>

273

274

<td><code><a name="_group_header"></a>_group_header(self,

275

group)</code>

276

</td></tr>

277

<tr><td align="right" valign="top" width="15%"> <code>string</code>

278

</td>

279

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_header" class="summary-sig-name"><code>_header</code></a>(self,

280

name)</code>

281

282

Return the HTML code for the header of a page with the given name.</td></tr>

283

284

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_linewrap_html" class="summary-sig-name"><code>_linewrap_html</code></a>(self,

285

str,

286

linelen,

287

maxlines)</code>

288

289

Add line-wrapping to the HTML string <code>str</code>.</td></tr>

290

<tr><td align="right" valign="top" width="15%"> <code>string</code>

291

</td>

292

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_link_to_html" class="summary-sig-name"><code>_link_to_html</code></a>(self,

293

link)</code>

294

295

Return the HTML code for the given link.</td></tr>

296

297

</td>

298

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_mkdir" class="summary-sig-name"><code>_mkdir</code></a>(self,

299

directory)</code>

300

301

If the given directory does not exist, then attempt to create it.</td></tr>

302

303

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_param_to_html" class="summary-sig-name"><code>_param_to_html</code></a>(self,

304

param,

305

show_defaults,

306

css_class)</code>

307

308

Return the HTML code for a single parameter.</td></tr>

309

310

<td><code><a name="_parameter_list"></a>_parameter_list(self,

311

parameters,

312

container,

313

heading)</code>

314

</td></tr>

315

316

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_pprint_var_value" class="summary-sig-name"><code>_pprint_var_value</code></a>(self,

317

var,

318

multiline,

319

summary_linelen)</code>

320

321

Return a string representation of the value of the variable <code>var</code>,

322

suitable for use in a <code><pre>...</pre></code> HTML

323

block.</td></tr>

324

325

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_property_in_public_details" class="summary-sig-name"><code>_property_in_public_details</code></a>(self,

326

puid)</code>

327

328

Return true if the given property should be shown in the public version of

329

the property details section.</td></tr>

330

<tr><td align="right" valign="top" width="15%"> <code>string</code>

331

</td>

332

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_public_private_link" class="summary-sig-name"><code>_public_private_link</code></a>(self,

333

where,

334

toc,

335

from_private)</code>

336

337

Return hTML code for the show/hide private selector.</td></tr>

338

<tr><td align="right" valign="top" width="15%"> <code>pair</code> of <code>list</code> of <a

339

href="epydoc.uid.Link-class.html"

340

class="link"><code>uid.Link</code></a>

341

</td>

342

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_split_classes" class="summary-sig-name"><code>_split_classes</code></a>(self,

343

classes_and_excepts)</code>

344

345

Divide the classes fromt the given module into exceptions and

346

non-exceptions.</td></tr>

347

<tr><td align="right" valign="top" width="15%"> <code>list</code> of <a

348

href="epydoc.markup.ParsedDocstring-class.html"

349

class="link"><code>markup.ParsedDocstring</code></a>

350

</td>

351

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_standard_field_values" class="summary-sig-name"><code>_standard_field_values</code></a>(self,

352

doc)</code>

353

354

Return a list of epytext field values that includes all fields that are

355

common to all <a href="epydoc.objdoc.ObjDoc-class.html"

356

class="link"><code>ObjDoc</code></a>s.</td></tr>

357

<tr><td align="right" valign="top" width="15%"> <code>string</code>

358

</td>

359

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_standard_fields" class="summary-sig-name"><code>_standard_fields</code></a>(self,

360

doc)</code>

361

362

Return hTML code containing descriptions of the epytext fields that are

363

common to all <a href="epydoc.objdoc.ObjDoc-class.html"

364

class="link"><code>ObjDoc</code></a>s (except for

365

<code>descr</code>).</td></tr>

366

<tr><td align="right" valign="top" width="15%"> <code>string</code>

367

</td>

368

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_start_of" class="summary-sig-name"><code>_start_of</code></a>(self,

369

heading)</code>

370

371

Return the HTML code for a 'start-of' comment.</td></tr>

372

<tr><td align="right" valign="top" width="15%"> <code>string</code>

373

</td>

374

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_summary" class="summary-sig-name"><code>_summary</code></a>(self,

375

doc,

376

uid,

377

indent)</code>

378

379

Return the HTML code for the summary description of the object documented by

380

381

<tr><td align="right" valign="top" width="15%"> <code>string</code>

382

</td>

383

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_table_header" class="summary-sig-name"><code>_table_header</code></a>(self,

384

heading,

385

css_class)</code>

386

387

Return the HTML code for the start of a table.</td></tr>

388

389

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_term_index_to_anchor" class="summary-sig-name"><code>_term_index_to_anchor</code></a>(self,

390

term)</code>

391

392

Given the name of an inline index item, construct a URI anchor.</td></tr>

393

394

<td><code><a name="_uid_to_filename"></a>_uid_to_filename(self,

395

uid)</code>

396

</td></tr>

397

<tr><td align="right" valign="top" width="15%"> <code>string</code>

398

</td>

399

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_uid_to_href" class="summary-sig-name"><code>_uid_to_href</code></a>(self,

400

uid,

401

label,

402

css_class,

403

code)</code>

404

405

Return the HTML code to link to the given UID.</td></tr>

406

<tr><td align="right" valign="top" width="15%"> <code>string</code>

407

</td>

408

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_uid_to_uri" class="summary-sig-name"><code>_uid_to_uri</code></a>(self,

409

uid)</code>

410

411

Return a URI that points to the description of the object identified by

412

413

414

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_var_details_entry" class="summary-sig-name"><code>_var_details_entry</code></a>(self,

415

var,

416

container)</code>

417

418

Return the HTML code for an entry in the variable details section.</td></tr>

419

420

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_var_value_tooltip" class="summary-sig-name"><code>_var_value_tooltip</code></a>(self,

421

var)</code>

422

423

Return a string representation of the value of the variable <code>var</code>,

424

suitable for use in a tooltip.</td></tr>

425

426

</td>

427

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write" class="summary-sig-name"><code>_write</code></a>(self,

428

write_func,

429

directory,

430

filename,

431

progress_callback,

432

is_public,

433

*args)</code>

434

435

A helper for <a href="epydoc.html.HTMLFormatter-class.html#write"

436

class="link"><code>write</code></a>, that creates new public and private

437

streams for a given filename, and delegates writing to

438

<code>write_func</code>.</td></tr>

439

440

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_breadcrumbs" class="summary-sig-name"><code>_write_breadcrumbs</code></a>(self,

441

public,

442

private,

443

where)</code>

444

445

Write the HTML code for the breadcrumbs line to the given streams.</td></tr>

446

447

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_class" class="summary-sig-name"><code>_write_class</code></a>(self,

448

public,

449

private,

450

uid,

451

doc,

452

body_only)</code>

453

454

Write an HTML page describing the given module to the given

455

streams.</td></tr>

456

457

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_class_summary" class="summary-sig-name"><code>_write_class_summary</code></a>(self,

458

public,

459

private,

460

container,

461

classes,

462

heading)</code>

463

464

Write HTML code for a class summary table.</td></tr>

465

466

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_class_summary_row" class="summary-sig-name"><code>_write_class_summary_row</code></a>(self,

467

public,

468

private,

469

link)</code>

470

471

Write HTML code for a row in the class summary table.</td></tr>

472

473

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_class_tree" class="summary-sig-name"><code>_write_class_tree</code></a>(self,

474

public,

475

private)</code>

476

477

Write HTML code for a nested list showing the base/subclass

478

relationships between all documented classes.</td></tr>

479

480

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_class_tree_item" class="summary-sig-name"><code>_write_class_tree_item</code></a>(self,

481

public,

482

private,

483

uid,

484

depth,

485

public_base)</code>

486

487

Write HTML code for a list item describing a class and all of its

488

subclasses.</td></tr>

489

490

</td>

491

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_css" class="summary-sig-name"><code>_write_css</code></a>(self,

492

directory,

493

cssname)</code>

494

495

Write the CSS stylesheet in the given directory.</td></tr>

496

497

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_frames" class="summary-sig-name"><code>_write_frames</code></a>(self,

498

public,

499

private)</code>

500

501

Write the frames index file for the frames-based table of contents to

502

the given streams.</td></tr>

503

504

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_func_details" class="summary-sig-name"><code>_write_func_details</code></a>(self,

505

public,

506

private,

507

container,

508

functions,

509

heading)</code>

510

511

Write HTML code for a function details section.</td></tr>

512

513

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_func_summary" class="summary-sig-name"><code>_write_func_summary</code></a>(self,

514

public,

515

private,

516

container,

517

functions,

518

heading)</code>

519

520

Write HTML code for a function summary table.</td></tr>

521

522

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_func_summary_row" class="summary-sig-name"><code>_write_func_summary_row</code></a>(self,

523

public,

524

private,

525

function,

526

container)</code>

527

528

Write HTML code for a row in the function summary table.</td></tr>

529

530

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_help" class="summary-sig-name"><code>_write_help</code></a>(self,

531

public,

532

private)</code>

533

534

Write an HTML help file to the given streams.</td></tr>

535

536

<td><code><a name="_write_imports"></a>_write_imports(self,

537

public,

538

private,

539

doc)</code>

540

</td></tr>

541

542

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_index" class="summary-sig-name"><code>_write_index</code></a>(self,

543

directory,

544

frombase)</code>

545

546

Write an <code>index.html</code> file in the given directory.</td></tr>

547

548

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_indices" class="summary-sig-name"><code>_write_indices</code></a>(self,

549

public,

550

private)</code>

551

552

Write an HTML page containing the term and identifier indices to the

553

given streams.</td></tr>

554

555

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_inheritance_list" class="summary-sig-name"><code>_write_inheritance_list</code></a>(self,

556

public,

557

private,

558

links,

559

cls)</code>

560

561

Return a string containing HTML that lists all objects from that were

562

inherited from a base ancestor of <code>cls</code>.</td></tr>

563

564

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_module" class="summary-sig-name"><code>_write_module</code></a>(self,

565

public,

566

private,

567

uid,

568

doc,

569

body_only)</code>

570

571

Write an HTML page describing the given module to the given

572

streams.</td></tr>

573

574

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_module_list" class="summary-sig-name"><code>_write_module_list</code></a>(self,

575

public,

576

private,

577

container,

578

modules)</code>

579

580

Write HTML code for a list of the submodules to the given streams.</td></tr>

581

582

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_module_toc" class="summary-sig-name"><code>_write_module_toc</code></a>(self,

583

public,

584

private,

585

uid,

586

doc)</code>

587

588

Write an HTML page containing the table of contents page for the given

589

module to the given streams.</td></tr>

590

591

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_module_tree" class="summary-sig-name"><code>_write_module_tree</code></a>(self,

592

public,

593

private)</code>

594

595

Write HTML code for a nested list showing the submodule relationships

596

between all documented packages and modules.</td></tr>

597

598

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_module_tree_item" class="summary-sig-name"><code>_write_module_tree_item</code></a>(self,

599

public,

600

private,

601

uid,

602

depth)</code>

603

604

Write HTML for a list item describing a package/module and all of its

605

submodules.</td></tr>

606

607

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_navbar" class="summary-sig-name"><code>_write_navbar</code></a>(self,

608

public,

609

private,

610

where)</code>

611

612

Write the HTML code for the navigation bar to the given streams.</td></tr>

613

614

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_project_toc" class="summary-sig-name"><code>_write_project_toc</code></a>(self,

615

public,

616

private)</code>

617

618

Write an HTML page containing the table of contents page for the whole

619

project to the given streams.</td></tr>

620

621

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_property_details" class="summary-sig-name"><code>_write_property_details</code></a>(self,

622

public,

623

private,

624

container,

625

properties,

626

heading)</code>

627

628

Write HTML code for a properties details section.</td></tr>

629

630

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_property_details_entry" class="summary-sig-name"><code>_write_property_details_entry</code></a>(self,

631

public,

632

private,

633

property,

634

container)</code>

635

636

Write HTML code for an individual property in the properties details

637

section.</td></tr>

638

639

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_property_summary" class="summary-sig-name"><code>_write_property_summary</code></a>(self,

640

public,

641

private,

642

container,

643

properties,

644

heading)</code>

645

646

Write HTML code for a property summary table.</td></tr>

647

648

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_property_summary_row" class="summary-sig-name"><code>_write_property_summary_row</code></a>(self,

649

public,

650

private,

651

property,

652

container)</code>

653

654

Write HTML code for a row in the property summary table.</td></tr>

655

656

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_toc" class="summary-sig-name"><code>_write_toc</code></a>(self,

657

public,

658

private)</code>

659

660

Write an HTML page containing the top-level table of contents.</td></tr>

661

662

<td><code><a name="_write_toc_section"></a>_write_toc_section(self,

663

public,

664

private,

665

section,

666

links)</code>

667

</td></tr>

668

669

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_trees" class="summary-sig-name"><code>_write_trees</code></a>(self,

670

public,

671

private)</code>

672

673

Write an HTML page containing the module and class hierarchies to the

674

given streams.</td></tr>

675

676

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_var_details" class="summary-sig-name"><code>_write_var_details</code></a>(self,

677

public,

678

private,

679

container,

680

vars,

681

heading)</code>

682

683

Write HTML code for a variable details section.</td></tr>

684

685

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_var_summary" class="summary-sig-name"><code>_write_var_summary</code></a>(self,

686

public,

687

private,

688

container,

689

variables,

690

heading)</code>

691

692

Write HTML code for a variable summary table.</td></tr>

693

694

<td><code><a href="../private/epydoc.html.HTMLFormatter-class.html#_write_var_summary_row" class="summary-sig-name"><code>_write_var_summary_row</code></a>(self,

695

public,

696

private,

697

var,

698

container)</code>

699

700

Write HTML code for a row in the variable summary table.</td></tr>

701

</table>

702

703

704

705

706

707

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

708

709

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_create_private_docs"><code>_create_private_docs</code></a>: Whether or not to create documentation pages that include information

710

about private objects.</td></tr>

711

712

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_css"><code>_css</code></a>: The name of a file containing a CSS stylesheet; or the name of a CSS

713

stylesheet.</td></tr>

714

<tr><td align="right" valign="top" width="15%"><a href="epydoc.objdoc.DocMap-class.html"

715

class="link"><code>DocMap</code></a></td>

716

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_docmap"><code>_docmap</code></a>: The documentation map, encoding the objects that should be

717

documented.</td></tr>

718

719

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_frames_index"><code>_frames_index</code></a>: Whether or not to create a frames-based table of contents for the

720

documentation.</td></tr>

721

<tr><td align="right" valign="top" width="15%"><code>string</code></td>

722

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_prj_name"><code>_prj_name</code></a>: A name for the documentation (for the navbar).</td></tr>

723

<tr><td align="right" valign="top" width="15%"><code>string</code></td>

724

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_prj_url"><code>_prj_url</code></a>: A URL for the documentation (for the navpar).</td></tr>

725

726

727

728

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_variable_linelen"><code>_variable_linelen</code></a>: The maximum line length used for displaying the values of variables in

729

the variable details sections.</td></tr>

730

731

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_variable_maxlines"><code>_variable_maxlines</code></a>: The maximum number of lines that should be displayed for the value of

732

a variable in the variable details section.</td></tr>

733

734

<td><a href="../private/epydoc.html.HTMLFormatter-class.html#_variable_tooltip_linelen"><code>_variable_tooltip_linelen</code></a>: The maximum line length for variable value tooltips.</td></tr>

735

</table>

736

737

738

739

740

741

<th colspan="2">Instance Method Details</th></tr>

742

</table>

743

744

745

746

<h3>__init__(self,

747

docmap,

748

**kwargs)

749

(Constructor)

750

</h3>

751

Construct a new HTML formatter, using the given documentation

752

map.

753

754

<dl><dt>Parameters:</dt>

755

<dd><code>docmap</code> -

756

The documentation to output.

757

758

(type=<a href="epydoc.objdoc.DocMap-class.html"

759

class="link"><code>DocMap</code></a>)

760

</dd>

761

</dl>

762

<dl><dt>Keyword Parameters:</dt>

763

<dd><code>prj_name</code> -

764

The name of the project. Defaults to none.

765

766

(type=<code>string</code>)

767

<dd><code>prj_url</code> -

768

The target for the project hopeage link on the navigation bar.

769

If <code>prj_url</code> is not specified, then no hyperlink is

770

created.

771

772

(type=<code>string</code>)

773

<dd><code>prj_link</code> -

774

The label for the project link on the navigation bar. This

775

link can contain arbitrary HTML code (e.g. images). By default, a

776

label is constructed from <code>prj_name</code>.

777

778

(type=<code>string</code>)

779

<dd><code>top</code> -

780

The top page for the documentation. This is the default page

781

shown main frame, when frames are enabled. <code>top</code> can

782

be a URL, the name of a module, the name of a class, or one of

783

the special strings <code>"trees.html"</code>,

784

<code>"indices.html"</code>, or

785

<code>"help.html"</code>. By default, the top-level

786

package or module is used, if there is one; otherwise,

787

<code>"trees"</code> is used.

788

789

(type=<code>string</code>)

790

<dd><code>css</code> -

791

The CSS stylesheet file. If <code>css</code> is a file name,

792

then the specified file's conents will be used. Otherwise, if

793

<code>css</code> is the name of a CSS stylesheet in <a

794

href="epydoc.css-module.html"

795

class="link"><code>epydoc.css</code></a>, then that stylesheet

796

will be used. Otherwise, an error is reported. If no stylesheet

797

is specified, then the default stylesheet is used.

798

799

(type=<code>string</code>)

800

<dd><code>private_css</code> -

801

The CSS stylesheet file for the private API documentation. If

802

<code>css</code> is a file name, then the specified file's

803

conents will be used. Otherwise, if <code>css</code> is the name

804

of a CSS stylesheet in <a href="epydoc.css-module.html"

805

class="link"><code>epydoc.css</code></a>, then that stylesheet

806

will be used. Otherwise, an error is reported. If no stylesheet

807

is specified, then the private API documentation will use the

808

same stylesheet as the public API documentation.

809

810

(type=<code>string</code>)

811

<dd><code>help</code> -

812

The name of the help file. If no help file is specified, then

813

the default help file will be used.

814

815

(type=<code>string</code>)

816

<dd><code>private</code> -

817

Whether to create documentation for private objects. By

818

default, private objects are documented.

819

820

(type=<code>boolean</code>)

821

<dd><code>frames</code> -

822

Whether to create a frames-based table of contents. By

823

default, it is produced.

824

825

(type=<code>boolean</code>))

826

<dd><code>show_imports</code> -

827

Whether or not to display lists of imported functions and

828

classes. By default, they are not shown.

829

830

(type=<code>boolean</code>)

831

<dd><code>index_parameters</code> -

832

Whether or not to include function parameters in the

833

identifier index. By default, they are not included.

834

835

(type=<code>boolean</code>)

836

<dd><code>variable_maxlines</code> -

837

The maximum number of lines that should be displayed for the

838

value of a variable in the variable details section. By default,

839

8 lines are displayed.

840

841

(type=<code>int</code>)

842

<dd><code>variable_linelength</code> -

843

The maximum line length used for displaying the values of

844

variables in the variable details sections. If a line is longer

845

than this length, then it will be wrapped to the next line. The

846

default line length is 70 characters.

847

848

(type=<code>int</code>)

849

<dd><code>variable_summary_linelength</code> -

850

The maximum line length used for displaying the values of

851

variables in the summary section. If a line is longer than this

852

length, then it will be truncated. The default is 40

853

characters.

854

855

(type=<code>int</code>)

856

<dd><code>variable_tooltip_linelength</code> -

857

The maximum line length used for tooltips for the values of

858

variables. If a line is longer than this length, then it will be

859

truncated. The default is 600 characters.

860

861

(type=<code>int</code>)

862

<dd><code>property_function_linelength</code> -

863

The maximum line length used to dispaly property functions

864

(<code>fget</code>, <code>fset</code>, and <code>fdel</code>)

865

that contain something other than a function object. The dfeault

866

length is 40 characters.

867

868

(type=<code>int</code>)

869

<dd><code>inheritance</code> -

870

How inherited objects should be displayed. If

871

<code>inheritance='grouped'</code>, then inherited objects are

872

gathered into groups; if <code>inheritance='listed'</code>, then

873

inherited objects are listed in a short list at the end of their

874

group; if <code>inheritance='included'</code>, then inherited

875

objects are mixed in with non-inherited objects. The default is

876

'grouped'.

877

878

(type=<code>string</code>)

879

</dd>

880

</dl>

881

</dd></dl>

882

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

883

884

885

886

<h3>num_files(self)

887

</h3>

888

889

<dl><dt>Returns:</dt>

890

<dd>

891

The number of files that this <code>HTMLFormatter</code> will

892

generate.

893

894

(type=<code>int</code>)

895

</dd>

896

</dl>

897

</dd></dl>

898

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

899

900

901

902

<h3>write(self,

903

directory=None,

904

progress_callback=None)

905

</h3>

906

Write the documentation to the given directory.

907

908

<dl><dt>Parameters:</dt>

909

<dd><code>directory</code> -

910

The directory to which output should be written. If no

911

directory is specified, output will be written to the current

912

directory. If the directory does not exist, it will be

913

created.

914

915

(type=<code>string</code>)

916

<dd><code>progress_callback</code> -

917

A callback function that is called before each file is

918

written, with the name of the created file.

919

920

(type=<code>function</code>)

921

</dd>

922

</dl>

923

<dl><dt>Returns:</dt>

924

<dd>

925

926

</dd>

927

</dl>

928

<dl><dt>Raises:</dt>

929

<dd><code>OSError</code> -

930

If <code>directory</code> cannot be created,

931

<dd><code>OSError</code> -

932

If any file cannot be created or written to.

933

</dl>

934

</dd></dl>

935

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

936

937

938

939

<h3>_base_tree(self,

940

uid,

941

width=None,

942

postfix='')

943

</h3>

944

945

<dl><dt>Returns:</dt>

946

<dd>

947

The HTML code for a class's base tree. The tree is drawn

948

'upside-down' and right justified, to allow for multiple

949

inheritance.

950

951

(type=<code>string</code>)

952

</dd>

953

</dl>

954

</dd></dl>

955

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

956

957

958

959

<h3>_breadcrumbs(self,

960

uid)

961

</h3>

962

963

<dl><dt>Parameters:</dt>

964

<dd><code>uid</code> -

965

The UID of the object whose ancestors should be listed.

966

</dd>

967

</dl>

968

<dl><dt>Returns:</dt>

969

<dd>

970

The HTML code for a series of links to the ancestors of

971

<code>uid</code>.

972

973

(type=<code>string</code>)

974

</dd>

975

</dl>

976

</dd></dl>

977

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

978

979

980

981

<h3>_descrlist(self,

982

items,

983

singular,

984

plural=None,

985

short=0)

986

</h3>

987

988

<dl><dt>Parameters:</dt>

989

<dd><code>items</code> -

990

The description items.

991

992

(type=<code>list</code> of <code>string</code>)

993

<dd><code>singular</code> -

994

The name of the list, if there is one element.

995

<dd><code>plural</code> -

996

The name of the list, if there are multiple elements.

997

</dd>

998

</dl>

999

<dl><dt>Returns:</dt>

1000

<dd>

1001

The HTML code for a list of description items.

1002

</dd>

1003

</dl>

1004

</dd></dl>

1005

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

1006

1007

1008

1009

<h3>_docstring_to_html(self,

1010

docstring,

1011

uid,

1012

indent=0)

1013

</h3>

1014

1015

<dl><dt>Parameters:</dt>

1016

1017

1018

(type=<code>None</code> or <code>UID</code>)

1019

</dd>

1020

</dl>

1021

<dl><dt>Returns:</dt>

1022

<dd>

1023

A string containing the HTML encoding for the given

1024

<code>ParsedDocstring</code>

1025

1026

(type=<a href="epydoc.markup.ParsedDocstring-class.html"

1027

class="link"><code>markup.ParsedDocstring</code></a>)

1028

</dd>

1029

</dl>

1030

</dd></dl>

1031

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

1032

1033

1034

1035

<h3>_documented(self,

1036

uid)

1037

</h3>

1038

1039

<dl><dt>Returns:</dt>

1040

<dd>

1041

True if the given UID is documented by the documentation map

1042

for this <code>HTMLFormatter</code>.

1043

1044

(type=<code>boolean</code>)

1045

</dd>

1046

</dl>

1047

</dd></dl>

1048

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

1049

1050

1051

1052

<h3>_extract_identifier_index(self)

1053

</h3>

1054

1055

<dl><dt>Returns:</dt>

1056

<dd>

1057

A list of the <code>UID</code>s of all objects and variables

1058

documented by <code>_docmap</code>. This list is used by <a

1059

href="../private/epydoc.html.HTMLFormatter-class.html#_write_indices"

1060

class="link"><code>_write_indices</code></a> to construct the

1061

identifier index.

1062

1063

(type=<code>list</code> of <a href="epydoc.uid.UID-class.html"

1064

class="link"><code>UID</code></a>)

1065

</dd>

1066

</dl>

1067

</dd></dl>

1068

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

1069

1070

1071

1072

<h3>_extract_term_index(self)

1073

</h3>

1074

Extract the set of terms that should be indexed from all documented

1075

docstrings. Return the extracted set as a list of tuples of the form

1076

<code>(key, term, [links])</code>. This list is used by <a

1077

href="../private/epydoc.html.HTMLFormatter-class.html#_write_indices"

1078

class="link"><code>_write_indices</code></a> to construct the term

1079

index.

1080

1081

<dl><dt>Returns:</dt>

1082

<dd>

1083

<code>list</code> of <code>(string, <a

1084

href="epydoc.markup.ParsedDocstring-class.html"

1085

class="link"><code>markup.ParsedDocstring</code></a>, list of

1086

Link)</code>

1087

</dd>

1088

</dl>

1089

</dd></dl>

1090

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

1091

1092

1093

1094

<h3>_find_top_page(self,

1095

pagename)

1096

</h3>

1097

Find the top page for the API documentation. This page is used as

1098

the default page shown in the main frame, when frames are used. When

1099

frames are not used, a redirect page is created from

1100

<code>index.html</code> to the top page.

1101

1102

<dl><dt>Parameters:</dt>

1103

<dd><code>pagename</code> -

1104

The name of the page, as specified by the keyword argument

1105

<code>top</code> to the constructor.

1106

1107

(type=<code>string</code>)

1108

</dd>

1109

</dl>

1110

<dl><dt>Returns:</dt>

1111

<dd>

1112

The URL of the top page.

1113

1114

(type=<code>string</code>)

1115

</dd>

1116

</dl>

1117

</dd></dl>

1118

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

1119

1120

1121

1122

<h3>_find_toplevel(self)

1123

</h3>

1124

1125

<dl><dt>Returns:</dt>

1126

<dd>

1127

The UID of the top-level module or package, or

1128

<code>None</code> if there is no top-level module or

1129

package.

1130

1131

(type=<a href="epydoc.uid.UID-class.html"

1132

class="link"><code>UID</code></a> or <code>None</code>)

1133

</dd>

1134

</dl>

1135

</dd></dl>

1136

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

1137

1138

1139

1140

<h3>_find_tree_width(self,

1141

uid)

1142

</h3>

1143

Helper function for <a

1144

href="../private/epydoc.html.HTMLFormatter-class.html#_base_tree"

1145

class="link"><code>_base_tree</code></a>.

1146

1147

<dl><dt>Returns:</dt>

1148

<dd>

1149

The width of a base tree, when drawn right-justified. This is

1150

used by <a

1151

href="../private/epydoc.html.HTMLFormatter-class.html#_base_tree"

1152

class="link"><code>_base_tree</code></a> to determine how far to

1153

indent lines of the base tree.

1154

1155

(type=<code>int</code>)

1156

</dd>

1157

</dl>

1158

</dd></dl>

1159

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

1160

1161

1162

1163

<h3>_footer(self)

1164

</h3>

1165

1166

<dl><dt>Returns:</dt>

1167

<dd>

1168

The HTML code for the footer of a page.

1169

1170

(type=<code>string</code>)

1171

</dd>

1172

</dl>

1173

</dd></dl>

1174

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

1175

1176

1177

1178

<h3>_frames_link(self,

1179

where)

1180

</h3>

1181

1182

<dl><dt>Parameters:</dt>

1183

<dd><code>where</code> -

1184

An identifier indiciating the page we're creating a navigation

1185

bar for. This is either a UID or the name of a file without the

1186

".html" extension.

1187

</dd>

1188

</dl>

1189

<dl><dt>Returns:</dt>

1190

<dd>

1191

HTML code for the frames/noframes selector. This selector is

1192

used to turn the frames-based table of contents on or off.

1193

1194

(type=<code>string</code>)

1195

</dd>

1196

</dl>

1197

</dd></dl>

1198

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

1199

1200

1201

1202

<h3>_func_details_entry(self,

1203

function,

1204

container)

1205

</h3>

1206

1207

<dl><dt>Parameters:</dt>

1208

<dd><code>function</code> -

1209

The function that should be described by this entry.

1210

1211

(type=<a href="epydoc.uid.Link-class.html"

1212

class="link"><code>Link</code></a>)

1213

</dd>

1214

</dl>

1215

<dl><dt>Returns:</dt>

1216

<dd>

1217

The HTML code for an entry in the function details section.

1218

Each entry gives a complete description of a documented

1219

function.

1220

</dd>

1221

</dl>

1222

</dd></dl>

1223

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

1224

1225

1226

1227

<h3>_func_signature(self,

1228

fname,

1229

fuid,

1230

fdoc,

1231

href=0,

1232

show_defaults=1,

1233

css_class='sig')

1234

</h3>

1235

1236

<dl><dt>Parameters:</dt>

1237

<dd><code>fname</code> -

1238

The short name of the function.

1239

1240

(type=<code>string</code>)

1241

<dd><code>fuid</code> -

1242

The UID of the function (used to generate the optional href

1243

link).

1244

1245

(type=<a href="epydoc.uid.UID-class.html"

1246

class="link"><code>UID</code></a>)

1247

<dd><code>fdoc</code> -

1248

The documentation for the function.

1249

1250

(type=<a href="epydoc.objdoc.FuncDoc-class.html"

1251

class="link"><code>objdoc.FuncDoc</code></a>)

1252

<dd><code>href</code> -

1253

Whether to create an href link from the function's name to its

1254

details description.

1255

<dd><code>show_defaults</code> -

1256

Whether or not to show default values for parameters.

1257

<dd><code>css_class</code> -

1258

The CSS class that should be used to mark the signature.

1259

</dd>

1260

</dl>

1261

<dl><dt>Returns:</dt>

1262

<dd>

1263

The HTML code for the function signature of the function with

1264

the given name and documentation.

1265

</dd>

1266

</dl>

1267

</dd></dl>

1268

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

1269

1270

1271

1272

<h3>_get_index_terms(self,

1273

parsed_docstring,

1274

link,

1275

terms,

1276

links)

1277

</h3>

1278

A helper function for <a

1279

href="../private/epydoc.html.HTMLFormatter-class.html#_extract_term_index"

1280

class="link"><code>_extract_term_index</code></a>.

1281

For each index term t with key <i

1282

class="math">k in <code>parsed_docstring</code>, modify

1283

<code>terms</code> and <code>links</code> as follows:

1284

<ul>

1285

<li>

1286

Set <code>terms[k] = t</code> (if

1287

<code>terms[k]</code> doesn't exist).

1288

</li>

1289

<li>

1290

Append <code>link</code> to <code>links[<i

1291

class="math">k]</code>.

1292

</li>

1293

</ul>

1294

1295

</dd></dl>

1296

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

1297

1298

1299

1300

<h3>_header(self,

1301

name)

1302

</h3>

1303

1304

<dl><dt>Returns:</dt>

1305

<dd>

1306

The HTML code for the header of a page with the given

1307

name.

1308

1309

(type=<code>string</code>)

1310

</dd>

1311

</dl>

1312

</dd></dl>

1313

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

1314

1315

1316

1317

<h3>_linewrap_html(self,

1318

str,

1319

linelen,

1320

maxlines)

1321

</h3>

1322

Add line-wrapping to the HTML string <code>str</code>. Line length

1323

is determined by <code>linelen</code>; and the maximum number of lines

1324

to display is determined by <code>maxlines</code>. This function treats

1325

HTML entities (e.g., <code>&amp;</code>) as single characters; and

1326

ignores HTML tags (e.g., <code></code>).

1327

1328

</dd></dl>

1329

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

1330

1331

1332

1333

<h3>_link_to_html(self,

1334

link)

1335

</h3>

1336

1337

<dl><dt>Parameters:</dt>

1338

1339

1340

(type=<a href="epydoc.uid.Link-class.html"

1341

class="link"><code>uid.Link</code></a>)

1342

</dd>

1343

</dl>

1344

<dl><dt>Returns:</dt>

1345

<dd>

1346

The HTML code for the given link. This code consists of an

1347

anchor with an href to the page for the link's target, and with

1348

text taken from the link's name. If the target is not documented,

1349

then the HTML code will just contain the name, and no href.

1350

1351

(type=<code>string</code>)

1352

</dd>

1353

</dl>

1354

</dd></dl>

1355

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

1356

1357

1358

1359

<h3>_mkdir(self,

1360

directory)

1361

</h3>

1362

If the given directory does not exist, then attempt to create

1363

it.

1364

1365

<dl><dt>Returns:</dt>

1366

<dd>

1367

1368

</dd>

1369

</dl>

1370

</dd></dl>

1371

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

1372

1373

1374

1375

<h3>_param_to_html(self,

1376

param,

1377

show_defaults,

1378

css_class)

1379

</h3>

1380

1381

<dl><dt>Parameters:</dt>

1382

<dd><code>show_defaults</code> -

1383

Whether or not to show default values for parameters.

1384

<dd><code>css_class</code> -

1385

The CSS class that should be used to mark the signature.

1386

</dd>

1387

</dl>

1388

<dl><dt>Returns:</dt>

1389

<dd>

1390

The HTML code for a single parameter. Note that a single

1391

parameter can consists of a sublist of parameters (although this

1392

feature isn't often used). This is a helper function for <a

1393

href="../private/epydoc.html.HTMLFormatter-class.html#_func_signature"

1394

class="link"><code>_func_signature</code></a>.

1395

</dd>

1396

</dl>

1397

</dd></dl>

1398

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

1399

1400

1401

1402

<h3>_pprint_var_value(self,

1403

var,

1404

multiline=1,

1405

summary_linelen=0)

1406

</h3>

1407

1408

<dl><dt>Parameters:</dt>

1409

1410

1411

(type=<a href="epydoc.objdoc.Var-class.html"

1412

class="link"><code>Var</code></a>)

1413

</dd>

1414

</dl>

1415

<dl><dt>Returns:</dt>

1416

<dd>

1417

A string representation of the value of the variable

1418

<code>var</code>, suitable for use in a

1419

<code><pre>...</pre></code> HTML block.

1420

</dd>

1421

</dl>

1422

</dd></dl>

1423

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

1424

1425

1426

1427

<h3>_property_in_public_details(self,

1428

puid)

1429

</h3>

1430

1431

<dl><dt>Returns:</dt>

1432

<dd>

1433

True if the given property should be shown in the public

1434

version of the property details section.

1435

</dd>

1436

</dl>

1437

</dd></dl>

1438

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

1439

1440

1441

1442

<h3>_public_private_link(self,

1443

where,

1444

toc=0,

1445

from_private=0)

1446

</h3>

1447

1448

<dl><dt>Parameters:</dt>

1449

<dd><code>where</code> -

1450

An identifier indiciating the page we're creating a navigation

1451

bar for. This is either a UID or the name of a file without the

1452

".html" extension.

1453

</dd>

1454

</dl>

1455

<dl><dt>Returns:</dt>

1456

<dd>

1457

HTML code for the show/hide private selector. This selector is

1458

used to select whether private objects should be displayed.

1459

1460

(type=<code>string</code>)

1461

</dd>

1462

</dl>

1463

</dd></dl>

1464

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

1465

1466

1467

1468

<h3>_split_classes(self,

1469

classes_and_excepts)

1470

</h3>

1471

Divide the classes fromt the given module into exceptions and

1472

non-exceptions. This is used by <a

1473

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"

1474

class="link"><code>_write_module</code></a> to list exceptions and

1475

non-exceptions separately.

1476

1477

<dl><dt>Parameters:</dt>

1478

<dd><code>classes_and_excepts</code> -

1479

The list of classes to split up.

1480

1481

(type=<code>list</code> of <a

1482

href="epydoc.uid.Link-class.html"

1483

class="link"><code>uid.Link</code></a>)

1484

</dd>

1485

</dl>

1486

<dl><dt>Returns:</dt>

1487

<dd>

1488

A list <code>(classes, excepts)</code>, where

1489

<code>classes</code> is the list of non-exception classes,

1490

and <code>excepts</code> is the list of exception

1491

classes.

1492

1493

(type=<code>pair</code> of <code>list</code> of <a

1494

href="epydoc.uid.Link-class.html"

1495

class="link"><code>uid.Link</code></a>)

1496

</dd>

1497

</dl>

1498

</dd></dl>

1499

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

1500

1501

1502

1503

<h3>_standard_field_values(self,

1504

doc)

1505

</h3>

1506

1507

<dl><dt>Returns:</dt>

1508

<dd>

1509

A list of epytext field values that includes all fields that

1510

are common to all <a href="epydoc.objdoc.ObjDoc-class.html"

1511

class="link"><code>ObjDoc</code></a>s.

1512

<code>_standard_field_values</code> is used by <a

1513

href="../private/epydoc.html.HTMLFormatter-class.html#_extract_term_index"

1514

class="link"><code>_extract_term_index</code></a>.

1515

1516

(type=<code>list</code> of <a

1517

href="epydoc.markup.ParsedDocstring-class.html"

1518

class="link"><code>markup.ParsedDocstring</code></a>)

1519

</dd>

1520

</dl>

1521

</dd></dl>

1522

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

1523

1524

1525

1526

<h3>_standard_fields(self,

1527

doc)

1528

</h3>

1529

1530

<dl><dt>Parameters:</dt>

1531

<dd><code>doc</code> -

1532

The object whose fields should be described.

1533

</dd>

1534

</dl>

1535

<dl><dt>Returns:</dt>

1536

<dd>

1537

HTML code containing descriptions of the epytext fields that

1538

are common to all <a href="epydoc.objdoc.ObjDoc-class.html"

1539

class="link"><code>ObjDoc</code></a>s (except for

1540

<code>descr</code>).

1541

1542

(type=<code>string</code>)

1543

</dd>

1544

</dl>

1545

</dd></dl>

1546

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

1547

1548

1549

1550

<h3>_start_of(self,

1551

heading)

1552

</h3>

1553

1554

<dl><dt>Parameters:</dt>

1555

<dd><code>heading</code> -

1556

The name of the section that is starting.

1557

1558

(type=<code>string</code>)

1559

</dd>

1560

</dl>

1561

<dl><dt>Returns:</dt>

1562

<dd>

1563

The HTML code for a 'start-of' comment. These comments are

1564

used to deliniate sections of the HTML output.

1565

1566

(type=<code>string</code>)

1567

</dd>

1568

</dl>

1569

</dd></dl>

1570

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

1571

1572

1573

1574

<h3>_summary(self,

1575

doc,

1576

uid,

1577

indent=0)

1578

</h3>

1579

1580

<dl><dt>Parameters:</dt>

1581

<dd><code>doc</code> -

1582

The documentation for the object whose summary should be

1583

returned.

1584

1585

(type=<a href="epydoc.objdoc.ObjDoc-class.html"

1586

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

1587

1588

1589

(type=<a href="epydoc.uid.UID-class.html"

1590

class="link"><code>uid.UID</code></a>)

1591

</dd>

1592

</dl>

1593

<dl><dt>Returns:</dt>

1594

<dd>

1595

The HTML code for the summary description of the object

1596

documented by <code>doc</code>. A summary description is the

1597

first sentence of the <code>doc</code>'s 'description' field. If

1598

the <code>doc</code> has no 'description' field, but does have a

1599

'return' field, then the summary is taken from the return field

1600

instead.

1601

1602

(type=<code>string</code>)

1603

</dd>

1604

</dl>

1605

</dd></dl>

1606

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

1607

1608

1609

1610

<h3>_table_header(self,

1611

heading,

1612

css_class)

1613

</h3>

1614

1615

<dl><dt>Parameters:</dt>

1616

<dd><code>heading</code> -

1617

The name for the table.

1618

1619

(type=<code>string</code>)

1620

<dd><code>css_class</code> -

1621

The css class for the table. This is used to allow different

1622

tables to be given different styles. Currently, the following

1623

classes are used: <code>'summary'</code>; <code>'details'</code>;

1624

and <code>'index'</code>.

1625

</dd>

1626

</dl>

1627

<dl><dt>Returns:</dt>

1628

<dd>

1629

The HTML code for the start of a table. This is used by class

1630

tables, function tables, variable tables, etc.

1631

1632

(type=<code>string</code>)

1633

</dd>

1634

</dl>

1635

</dd></dl>

1636

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

1637

1638

1639

1640

<h3>_term_index_to_anchor(self,

1641

term)

1642

</h3>

1643

Given the name of an inline index item, construct a URI anchor.

1644

These anchors are used to create links from the index page to each

1645

index item.

1646

1647

</dd></dl>

1648

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

1649

1650

1651

1652

<h3>_uid_to_href(self,

1653

uid,

1654

label=None,

1655

css_class=None,

1656

code=1)

1657

</h3>

1658

1659

<dl><dt>Parameters:</dt>

1660

1661

1662

(type=<a href="epydoc.uid.UID-class.html"

1663

class="link"><code>uid.UID</code></a>)

1664

<dd><code>label</code>

1665

1666

(type=<code>string</code>)

1667

<dd><code>code</code> -

1668

Whether or not to include

1669

<code><code>...</code></code> tags around the

1670

label.

1671

</dd>

1672

</dl>

1673

<dl><dt>Returns:</dt>

1674

<dd>

1675

The HTML code to link to the given UID. This code consists of

1676

an anchor with an href to the page for <code>uid</code>. If

1677

<code>label</code> is not <code>None</code>, then it is used as

1678

the text for the link; otherwise, <code>uid</code> is used as the

1679

text. If <code>uid</code> is not documented, then the HTML code

1680

will just contain the name, and no href.

1681

1682

(type=<code>string</code>)

1683

</dd>

1684

</dl>

1685

</dd></dl>

1686

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

1687

1688

1689

1690

<h3>_uid_to_uri(self,

1691

uid)

1692

</h3>

1693

1694

<dl><dt>Parameters:</dt>

1695

<dd><code>uid</code> -

1696

A unique identifier for the object.

1697

1698

(type=<a href="epydoc.uid.UID-class.html"

1699

class="link"><code>UID</code></a>)

1700

</dd>

1701

</dl>

1702

<dl><dt>Returns:</dt>

1703

<dd>

1704

a URI that points to the description of the object identified

1705

by <code>uid</code>.

1706

1707

(type=<code>string</code>)

1708

</dd>

1709

</dl>

1710

</dd></dl>

1711

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

1712

1713

1714

1715

<h3>_var_details_entry(self,

1716

var,

1717

container)

1718

</h3>

1719

1720

<dl><dt>Parameters:</dt>

1721

<dd><code>var</code> -

1722

The variable that should be described.

1723

</dd>

1724

</dl>

1725

<dl><dt>Returns:</dt>

1726

<dd>

1727

The HTML code for an entry in the variable details section.

1728

Each entry gives a complete description of a documented

1729

variable.

1730

</dd>

1731

</dl>

1732

</dd></dl>

1733

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

1734

1735

1736

1737

<h3>_var_value_tooltip(self,

1738

var)

1739

</h3>

1740

1741

<dl><dt>Parameters:</dt>

1742

1743

1744

(type=<a href="epydoc.objdoc.Var-class.html"

1745

class="link"><code>Var</code></a>)

1746

</dd>

1747

</dl>

1748

<dl><dt>Returns:</dt>

1749

<dd>

1750

A string representation of the value of the variable

1751

<code>var</code>, suitable for use in a tooltip. In particular,

1752

use <code>repr</code> to convert the var to a string; truncate it

1753

to <a

1754

href="../private/epydoc.html.HTMLFormatter-class.html#_variable_tooltip_linelen"

1755

class="link"><code>_variable_tooltip_linelen</code></a>; and

1756

convert it to HTML.

1757

</dd>

1758

</dl>

1759

</dd></dl>

1760

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

1761

1762

1763

1764

<h3>_write(self,

1765

write_func,

1766

directory,

1767

filename,

1768

progress_callback,

1769

is_public,

1770

*args)

1771

</h3>

1772

A helper for <a href="epydoc.html.HTMLFormatter-class.html#write"

1773

class="link"><code>write</code></a>, that creates new public and

1774

private streams for a given filename, and delegates writing to

1775

<code>write_func</code>. If <a

1776

href="../private/epydoc.html.HTMLFormatter-class.html#_create_private_docs"

1777

class="link"><code>_create_private_docs</code></a> is true, then the

1778

streams are created in the <code>'public'</code> and

1779

<code>'private'</code> subdirectories of <code>directory</code>. If

1780

it's false, then the public stream is created in

1781

<code>directory</code>, and a <a

1782

href="../private/epydoc.html._DevNull-class.html"

1783

class="link"><code>_DevNull</code></a> is used for the private

1784

stream.

1785

1786

<dl><dt>Parameters:</dt>

1787

<dd><code>write_func</code> -

1788

The output function to delegate to. It is called with a public

1789

stream, a private stream, and any arguments given in

1790

<code>args</code>.

1791

<dd><code>directory</code> -

1792

The base directory for the output files

1793

<dd><code>filename</code> -

1794

The filename of the file(s) that <code>write_func</code>

1795

should write to.

1796

<dd><code>progress_callback</code> -

1797

A progress callback function. If it is not <code>None</code>,

1798

then it is called with <code>filename</code> before

1799

<code>write_func</code> is called.

1800

<dd><code>is_public</code> -

1801

Whether this is a public page. If it is not a public page,

1802

then a <code>_DevNull</code> will be used for the public stream.

1803

(Or if it is not a public page and

1804

<code>_create_private_docs</code> is false, then immediately

1805

return.)

1806

<dd><code>args</code> -

1807

Extra arguments for <code>write_func</code>

1808

</dd>

1809

</dl>

1810

<dl><dt>Returns:</dt>

1811

<dd>

1812

1813

</dd>

1814

</dl>

1815

</dd></dl>

1816

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

1817

1818

1819

1820

<h3>_write_breadcrumbs(self,

1821

public,

1822

private,

1823

where=None)

1824

</h3>

1825

Write the HTML code for the breadcrumbs line to the given streams.

1826

The breadcrumbs line is an invisible table with a list of pointers to

1827

the current object's ancestors on the left; and the show/hide private

1828

selector and the frames/noframes selector on the right.

1829

1830

<dl><dt>Parameters:</dt>

1831

<dd><code>public</code> -

1832

The output stream for the public version of the page.

1833

<dd><code>private</code> -

1834

The output stream for the private version of the page.

1835

<dd><code>where</code> -

1836

An identifier indicating what page we're creating a navigation

1837

bar for. This is either a UID (for an object documentation page);

1838

or a string. If it is a UID, then a list of pointers to its

1839

ancestors is displayed.

1840

</dd>

1841

</dl>

1842

</dd></dl>

1843

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

1844

1845

1846

1847

<h3>_write_class(self,

1848

public,

1849

private,

1850

uid,

1851

doc,

1852

body_only=0)

1853

</h3>

1854

Write an HTML page describing the given module to the given

1855

streams.

1856

1857

<dl><dt>Parameters:</dt>

1858

<dd><code>public</code> -

1859

The output stream for the public version of the page.

1860

<dd><code>private</code> -

1861

The output stream for the private version of the page.

1862

<dd><code>uid</code> -

1863

The UID of the module to document.

1864

<dd><code>doc</code> -

1865

The <a href="epydoc.objdoc.ModuleDoc-class.html"

1866

class="link"><code>ModuleDoc</code></a> of the module to

1867

document.

1868

</dd>

1869

</dl>

1870

</dd></dl>

1871

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

1872

1873

1874

1875

<h3>_write_class_summary(self,

1876

public,

1877

private,

1878

container,

1879

classes,

1880

heading='Class Summary')

1881

</h3>

1882

Write HTML code for a class summary table. This is used by <a

1883

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"

1884

class="link"><code>_write_module</code></a> to list the classes in a

1885

module.

1886

1887

<dl><dt>Parameters:</dt>

1888

<dd><code>public</code> -

1889

The output stream for the public version of the page.

1890

<dd><code>private</code> -

1891

The output stream for the private version of the page.

1892

<dd><code>container</code> -

1893

The module that contains the classes. <code>container</code>

1894

is used to group the classes.

1895

<dd><code>classes</code> -

1896

The classes that should be included in the list.

1897

</dd>

1898

</dl>

1899

</dd></dl>

1900

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

1901

1902

1903

1904

<h3>_write_class_summary_row(self,

1905

public,

1906

private,

1907

link)

1908

</h3>

1909

Write HTML code for a row in the class summary table. Each row gives

1910

the name and summary of a single class.

1911

1912

<dl><dt>Parameters:</dt>

1913

<dd><code>public</code> -

1914

The output stream for the public version of the page.

1915

<dd><code>private</code> -

1916

The output stream for the private version of the page.

1917

<dd><code>link</code> -

1918

A link to the class that should be described by this row.

1919

</dd>

1920

</dl>

1921

</dd></dl>

1922

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

1923

1924

1925

1926

<h3>_write_class_tree(self,

1927

public,

1928

private)

1929

</h3>

1930

Write HTML code for a nested list showing the base/subclass

1931

relationships between all documented classes. Each element of the

1932

top-level list is a class with no (documented) bases; and under each

1933

class is listed all of its subclasses. Note that in the case of

1934

multiple inheritance, a class may appear multiple times. This is used

1935

by <a

1936

href="../private/epydoc.html.HTMLFormatter-class.html#_write_trees"

1937

class="link"><code>_write_trees</code></a> to write the class

1938

hierarchy.

1939

1940

<dl><dt>Parameters:</dt>

1941

<dd><code>public</code> -

1942

The output stream for the public version of the page.

1943

<dd><code>private</code> -

1944

The output stream for the private version of the page.

1945

</dd>

1946

</dl>

1947

Bug: This function does not list public subclasses of private bases.

1948

1949

1950

To Do: For multiple inheritance, don't repeat subclasses the second time a

1951

class is mentioned; instead, link to the first mention.

1952

1953

1954

</dd></dl>

1955

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

1956

1957

1958

1959

<h3>_write_class_tree_item(self,

1960

public,

1961

private,

1962

uid,

1963

depth=2,

1964

public_base=1)

1965

</h3>

1966

Write HTML code for a list item describing a class and all of its

1967

subclasses. This is used by <a

1968

href="../private/epydoc.html.HTMLFormatter-class.html#_write_class_tree"

1969

class="link"><code>_write_class_tree</code></a> to write the class

1970

hierarchy.

1971

1972

<dl><dt>Parameters:</dt>

1973

<dd><code>public</code> -

1974

The output stream for the public version of the page.

1975

<dd><code>private</code> -

1976

The output stream for the private version of the page.

1977

<dd><code>uid</code> -

1978

The <code>UID</code> of the class tree to describe

1979

<dd><code>depth</code> -

1980

The indentation depth.

1981

<dd><code>public_base</code> -

1982

True if output should be generated for the public stream. This

1983

is prevents public classes with private bases from being

1984

listed.

1985

</dd>

1986

</dl>

1987

Bug: This doesn't generate </li> close tags.

1988

1989

1990

</dd></dl>

1991

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

1992

1993

1994

1995

<h3>_write_css(self,

1996

directory,

1997

cssname)

1998

</h3>

1999

Write the CSS stylesheet in the given directory. If

2000

<code>cssname</code> contains a stylesheet file or name (from <a

2001

href="epydoc.css-module.html"

2002

class="link"><code>epydoc.css</code></a>), then use that stylesheet;

2003

otherwise, if a stylesheet file already exists, use that stylesheet.

2004

Otherwise, use the default stylesheet.

2005

2006

<dl><dt>Returns:</dt>

2007

<dd>

2008

2009

</dd>

2010

</dl>

2011

</dd></dl>

2012

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

2013

2014

2015

2016

<h3>_write_frames(self,

2017

public,

2018

private)

2019

</h3>

2020

Write the frames index file for the frames-based table of contents

2021

to the given streams.

2022

2023

<dl><dt>Parameters:</dt>

2024

<dd><code>public</code> -

2025

The output stream for the public version of the page.

2026

<dd><code>private</code> -

2027

The output stream for the private version of the page.

2028

</dd>

2029

</dl>

2030

</dd></dl>

2031

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

2032

2033

2034

2035

<h3>_write_func_details(self,

2036

public,

2037

private,

2038

container,

2039

functions,

2040

heading='Function Details')

2041

</h3>

2042

Write HTML code for a function details section. This is used by <a

2043

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"

2044

class="link"><code>_write_module</code></a> to describe the functions

2045

in a module; and by <a

2046

href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"

2047

class="link"><code>_write_class</code></a> to describe the methods in a

2048

class.

2049

2050

<dl><dt>Parameters:</dt>

2051

<dd><code>public</code> -

2052

The output stream for the public version of the page.

2053

<dd><code>private</code> -

2054

The output stream for the private version of the page.

2055

<dd><code>container</code> -

2056

The module or class that contains the functions.

2057

<code>container</code> is used to group the functions.

2058

<dd><code>functions</code> -

2059

The functions that should be included in the section.

2060

</dd>

2061

</dl>

2062

</dd></dl>

2063

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

2064

2065

2066

2067

<h3>_write_func_summary(self,

2068

public,

2069

private,

2070

container,

2071

functions,

2072

heading='Function Summary')

2073

</h3>

2074

Write HTML code for a function summary table. This is used by <a

2075

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"

2076

class="link"><code>_write_module</code></a> to list the functions in a

2077

module; and by <a

2078

href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"

2079

class="link"><code>_write_class</code></a> to list the methods in a

2080

class.

2081

2082

<dl><dt>Parameters:</dt>

2083

<dd><code>public</code> -

2084

The output stream for the public version of the page.

2085

<dd><code>private</code> -

2086

The output stream for the private version of the page.

2087

<dd><code>container</code> -

2088

The module or class that contains the functions.

2089

<code>container</code> is used to group the functions.

2090

<dd><code>functions</code> -

2091

The functions that should be included in the list.

2092

</dd>

2093

</dl>

2094

</dd></dl>

2095

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

2096

2097

2098

2099

<h3>_write_func_summary_row(self,

2100

public,

2101

private,

2102

function,

2103

container)

2104

</h3>

2105

Write HTML code for a row in the function summary table. Each row

2106

gives a breif description of a single function.

2107

2108

<dl><dt>Parameters:</dt>

2109

<dd><code>public</code> -

2110

The output stream for the public version of the page.

2111

<dd><code>private</code> -

2112

The output stream for the private version of the page.

2113

<dd><code>function</code> -

2114

The function that should be described by this row.

2115

2116

(type=<a href="epydoc.uid.Link-class.html"

2117

class="link"><code>Link</code></a>)

2118

</dd>

2119

</dl>

2120

</dd></dl>

2121

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

2122

2123

2124

2125

<h3>_write_help(self,

2126

public,

2127

private)

2128

</h3>

2129

Write an HTML help file to the given streams. If

2130

<code>self._helpfile</code> contains a help file, then use it;

2131

otherwise, use the default helpfile from <a

2132

href="epydoc.help-module.html"

2133

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

2134

2135

<dl><dt>Parameters:</dt>

2136

<dd><code>public</code> -

2137

The output stream for the public version of the page.

2138

<dd><code>private</code> -

2139

The output stream for the private version of the page.

2140

</dd>

2141

</dl>

2142

</dd></dl>

2143

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

2144

2145

2146

2147

<h3>_write_index(self,

2148

directory,

2149

frombase)

2150

</h3>

2151

Write an <code>index.html</code> file in the given directory. The

2152

contents of this file are copied or linked from an existing page. The

2153

page used is determined by <a

2154

href="../private/epydoc.html.HTMLFormatter-class.html#_frames_index"

2155

class="link"><code>_frames_index</code></a> and <a

2156

href="../private/epydoc.html.HTMLFormatter-class.html#_top_page"

2157

class="link"><code>_top_page</code></a>:

2158

<ul>

2159

<li>

2160

If <a

2161

href="../private/epydoc.html.HTMLFormatter-class.html#_frames_index"

2162

class="link"><code>_frames_index</code></a> is true, then

2163

<code>frames.html</code> is copied.

2164

</li>

2165

<li>

2166

Otherwise, the page specified by <a

2167

href="../private/epydoc.html.HTMLFormatter-class.html#_top_page"

2168

class="link"><code>_top_page</code></a> is copied.

2169

</li>

2170

</ul>

2171

2172

<dl><dt>Parameters:</dt>

2173

<dd><code>frombase</code> -

2174

True if this is the index file for the base directory when we

2175

are generating both public and private documentation. In this

2176

case, all local hyperlinks should be changed to point into the

2177

<code>public</code> subdirectory.

2178

2179

(type=<code>boolean</code>)

2180

</dd>

2181

</dl>

2182

</dd></dl>

2183

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

2184

2185

2186

2187

<h3>_write_indices(self,

2188

public,

2189

private)

2190

</h3>

2191

Write an HTML page containing the term and identifier indices to the

2192

given streams.

2193

2194

<dl><dt>Parameters:</dt>

2195

<dd><code>public</code> -

2196

The output stream for the public version of the page.

2197

<dd><code>private</code> -

2198

The output stream for the private version of the page.

2199

</dd>

2200

</dl>

2201

Bug: If there are private indexed terms, but no public indexed terms, then

2202

this function will still write a header for the Term Index to the public

2203

stream.

2204

2205

2206

</dd></dl>

2207

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

2208

2209

2210

2211

<h3>_write_inheritance_list(self,

2212

public,

2213

private,

2214

links,

2215

cls)

2216

</h3>

2217

2218

<dl><dt>Parameters:</dt>

2219

<dd><code>links</code> -

2220

The set of member objects of <code>cls</code> that should be

2221

listed by ancestor.

2222

2223

(type=<code>list</code> of <a

2224

href="epydoc.uid.Link-class.html"

2225

class="link"><code>Link</code></a>)

2226

<dd><code>cls</code> -

2227

The UID of the class whose inherited objects should be

2228

listed.

2229

2230

(type=<a href="epydoc.uid.UID-class.html"

2231

class="link"><code>UID</code></a>)

2232

</dd>

2233

</dl>

2234

<dl><dt>Returns:</dt>

2235

<dd>

2236

A string containing HTML that lists all objects from that were

2237

inherited from a base ancestor of <code>cls</code>. Only the

2238

objects linked to from one of the links in <code>links</code> are

2239

considered. The HTML lists the objects in one row of a table,

2240

grouped by ancestor.

2241

</dd>

2242

</dl>

2243

</dd></dl>

2244

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

2245

2246

2247

2248

<h3>_write_module(self,

2249

public,

2250

private,

2251

uid,

2252

doc,

2253

body_only=0)

2254

</h3>

2255

Write an HTML page describing the given module to the given

2256

streams.

2257

2258

<dl><dt>Parameters:</dt>

2259

<dd><code>public</code> -

2260

The output stream for the public version of the page.

2261

<dd><code>private</code> -

2262

The output stream for the private version of the page.

2263

<dd><code>uid</code> -

2264

The UID of the module to document.

2265

<dd><code>doc</code> -

2266

The <a href="epydoc.objdoc.ModuleDoc-class.html"

2267

class="link"><code>ModuleDoc</code></a> of the module to

2268

document.

2269

</dd>

2270

</dl>

2271

</dd></dl>

2272

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

2273

2274

2275

2276

<h3>_write_module_list(self,

2277

public,

2278

private,

2279

container,

2280

modules)

2281

</h3>

2282

Write HTML code for a list of the submodules to the given streams.

2283

This is used by <a

2284

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"

2285

class="link"><code>_write_module</code></a> to list the submodules in a

2286

package.

2287

2288

<dl><dt>Parameters:</dt>

2289

<dd><code>public</code> -

2290

The output stream for the public version of the page.

2291

<dd><code>private</code> -

2292

The output stream for the private version of the page.

2293

<dd><code>container</code> -

2294

The package that contains the modules (as submodules).

2295

<code>container</code> is used to group the modules.

2296

<dd><code>modules</code> -

2297

The modules that should be included in the list.

2298

</dd>

2299

</dl>

2300

</dd></dl>

2301

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

2302

2303

2304

2305

<h3>_write_module_toc(self,

2306

public,

2307

private,

2308

uid,

2309

doc)

2310

</h3>

2311

Write an HTML page containing the table of contents page for the

2312

given module to the given streams. This page lists the modules,

2313

classes, exceptions, functions, and variables defined by the

2314

module.

2315

2316

<dl><dt>Parameters:</dt>

2317

<dd><code>public</code> -

2318

The output stream for the public version of the page.

2319

<dd><code>private</code> -

2320

The output stream for the private version of the page.

2321

</dd>

2322

</dl>

2323

</dd></dl>

2324

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

2325

2326

2327

2328

<h3>_write_module_tree(self,

2329

public,

2330

private)

2331

</h3>

2332

Write HTML code for a nested list showing the submodule

2333

relationships between all documented packages and modules. This is used

2334

by <a

2335

href="../private/epydoc.html.HTMLFormatter-class.html#_write_trees"

2336

class="link"><code>_write_trees</code></a> to write the module

2337

hierarchy.

2338

2339

<dl><dt>Parameters:</dt>

2340

<dd><code>public</code> -

2341

The output stream for the public version of the page.

2342

<dd><code>private</code> -

2343

The output stream for the private version of the page.

2344

</dd>

2345

</dl>

2346

</dd></dl>

2347

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

2348

2349

2350

2351

<h3>_write_module_tree_item(self,

2352

public,

2353

private,

2354

uid,

2355

depth=0)

2356

</h3>

2357

Write HTML for a list item describing a package/module and all of

2358

its submodules. This is used by both <a

2359

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module_tree"

2360

class="link"><code>_write_module_tree</code></a> and <a

2361

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module_list"

2362

class="link"><code>_write_module_list</code></a> to write package

2363

hierarchies.

2364

2365

<dl><dt>Parameters:</dt>

2366

<dd><code>public</code> -

2367

The output stream for the public version of the page.

2368

<dd><code>private</code> -

2369

The output stream for the private version of the page.

2370

<dd><code>uid</code> -

2371

The <code>UID</code> of the module to describe

2372

<dd><code>depth</code> -

2373

The indentation depth.

2374

</dd>

2375

</dl>

2376

Bug: This doesn't generate </li> close tags.

2377

2378

2379

</dd></dl>

2380

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

2381

2382

2383

2384

<h3>_write_navbar(self,

2385

public,

2386

private,

2387

where=None)

2388

</h3>

2389

Write the HTML code for the navigation bar to the given streams. The

2390

navigation bar typically looks like:

2391

2392

[ Home Trees Index Help Project ]

2393

</pre>

2394

2395

<dl><dt>Parameters:</dt>

2396

<dd><code>public</code> -

2397

The output stream for the public version of the page.

2398

<dd><code>private</code> -

2399

The output stream for the private version of the page.

2400

<dd><code>where</code> -

2401

An identifier indicating what page we're creating a navigation

2402

bar for. This is either a UID (for an object documentation page);

2403

or one of the strings <code>'tree'</code>, <code>'index'</code>,

2404

and <code>'help'</code>.

2405

2406

(type=<code>UID</code> or <code>string</code>)

2407

</dd>

2408

</dl>

2409

</dd></dl>

2410

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

2411

2412

2413

2414

<h3>_write_project_toc(self,

2415

public,

2416

private)

2417

</h3>

2418

Write an HTML page containing the table of contents page for the

2419

whole project to the given streams. This page lists the classes,

2420

exceptions, functions, and variables defined by any module or package

2421

in the project.

2422

2423

<dl><dt>Parameters:</dt>

2424

<dd><code>public</code> -

2425

The output stream for the public version of the page.

2426

<dd><code>private</code> -

2427

The output stream for the private version of the page.

2428

</dd>

2429

</dl>

2430

</dd></dl>

2431

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

2432

2433

2434

2435

<h3>_write_property_details(self,

2436

public,

2437

private,

2438

container,

2439

properties,

2440

heading='Property Details')

2441

</h3>

2442

Write HTML code for a properties details section. This is used by <a

2443

href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"

2444

class="link"><code>_write_class</code></a> to describe the properties

2445

in a class.

2446

2447

<dl><dt>Parameters:</dt>

2448

<dd><code>public</code> -

2449

The output stream for the public version of the page.

2450

<dd><code>private</code> -

2451

The output stream for the private version of the page.

2452

<dd><code>container</code> -

2453

The or class that contains the properties.

2454

<code>container</code> is used to group the functions.

2455

<dd><code>properties</code> -

2456

The properties that should be included in the section.

2457

</dd>

2458

</dl>

2459

</dd></dl>

2460

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

2461

2462

2463

2464

<h3>_write_property_details_entry(self,

2465

public,

2466

private,

2467

property,

2468

container)

2469

</h3>

2470

Write HTML code for an individual property in the properties details

2471

section. This is used by <a

2472

href="../private/epydoc.html.HTMLFormatter-class.html#_write_property_details"

2473

class="link"><code>_write_property_details</code></a>.

2474

2475

<dl><dt>Parameters:</dt>

2476

<dd><code>public</code> -

2477

The output stream for the public version of the page.

2478

<dd><code>private</code> -

2479

The output stream for the private version of the page.

2480

<dd><code>property</code> -

2481

The property that should be described by this entry.

2482

2483

(type=<a href="epydoc.uid.Link-class.html"

2484

class="link"><code>Link</code></a>)

2485

</dd>

2486

</dl>

2487

</dd></dl>

2488

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

2489

2490

2491

2492

<h3>_write_property_summary(self,

2493

public,

2494

private,

2495

container,

2496

properties,

2497

heading='Property Summary')

2498

</h3>

2499

Write HTML code for a property summary table. This is used by <a

2500

href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"

2501

class="link"><code>_write_class</code></a> to list the properties in a

2502

class.

2503

2504

<dl><dt>Parameters:</dt>

2505

<dd><code>public</code> -

2506

The output stream for the public version of the page.

2507

<dd><code>private</code> -

2508

The output stream for the private version of the page.

2509

<dd><code>container</code> -

2510

The module or class that contains the properties.

2511

<code>container</code> is used to group the properties.

2512

<dd><code>properties</code> -

2513

The properties that should be included in the list.

2514

</dd>

2515

</dl>

2516

</dd></dl>

2517

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

2518

2519

2520

2521

<h3>_write_property_summary_row(self,

2522

public,

2523

private,

2524

property,

2525

container)

2526

</h3>

2527

Write HTML code for a row in the property summary table. Each row

2528

gives a brief description of a single property.

2529

2530

<dl><dt>Parameters:</dt>

2531

<dd><code>public</code> -

2532

The output stream for the public version of the page.

2533

<dd><code>private</code> -

2534

The output stream for the private version of the page.

2535

<dd><code>property</code> -

2536

The property that should be described by this row.

2537

2538

(type=<a href="epydoc.uid.Link-class.html"

2539

class="link"><code>Link</code></a>)

2540

</dd>

2541

</dl>

2542

</dd></dl>

2543

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

2544

2545

2546

2547

<h3>_write_toc(self,

2548

public,

2549

private)

2550

</h3>

2551

Write an HTML page containing the top-level table of contents. This

2552

page is used to select a module table of contents page, or the

2553

"everything" table of contents page.

2554

2555

<dl><dt>Parameters:</dt>

2556

<dd><code>public</code> -

2557

The output stream for the public version of the page.

2558

<dd><code>private</code> -

2559

The output stream for the private version of the page.

2560

</dd>

2561

</dl>

2562

</dd></dl>

2563

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

2564

2565

2566

2567

<h3>_write_trees(self,

2568

public,

2569

private)

2570

</h3>

2571

Write an HTML page containing the module and class hierarchies to

2572

the given streams.

2573

2574

<dl><dt>Parameters:</dt>

2575

<dd><code>public</code> -

2576

The output stream for the public version of the page.

2577

<dd><code>private</code> -

2578

The output stream for the private version of the page.

2579

</dd>

2580

</dl>

2581

</dd></dl>

2582

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

2583

2584

2585

2586

<h3>_write_var_details(self,

2587

public,

2588

private,

2589

container,

2590

vars,

2591

heading='Variable Details')

2592

</h3>

2593

Write HTML code for a variable details section. This is used by <a

2594

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"

2595

class="link"><code>_write_module</code></a> to describe the variables

2596

in a module; and by <a

2597

href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"

2598

class="link"><code>_write_class</code></a> to describe the instance and

2599

class variables in a class.

2600

2601

<dl><dt>Parameters:</dt>

2602

<dd><code>public</code> -

2603

The output stream for the public version of the page.

2604

<dd><code>private</code> -

2605

The output stream for the private version of the page.

2606

<dd><code>container</code> -

2607

The module or class that contains the variables.

2608

<code>container</code> is used to group the properties.

2609

<dd><code>vars</code> -

2610

The variables that should be included in the section.

2611

</dd>

2612

</dl>

2613

</dd></dl>

2614

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

2615

2616

2617

2618

<h3>_write_var_summary(self,

2619

public,

2620

private,

2621

container,

2622

variables,

2623

heading='Variable Summary')

2624

</h3>

2625

Write HTML code for a variable summary table. This is used by <a

2626

href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"

2627

class="link"><code>_write_module</code></a> to list the variables in a

2628

module; and by <a

2629

href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"

2630

class="link"><code>_write_class</code></a> to list the instance and

2631

class variables in a class.

2632

2633

<dl><dt>Parameters:</dt>

2634

<dd><code>public</code> -

2635

The output stream for the public version of the page.

2636

<dd><code>private</code> -

2637

The output stream for the private version of the page.

2638

<dd><code>container</code> -

2639

The module or class that contains the variables.

2640

<code>container</code> is used to group the properties.

2641

<dd><code>variables</code> -

2642

The variables that should be included in the list.

2643

</dd>

2644

</dl>

2645

</dd></dl>

2646

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

2647

2648

2649

2650

<h3>_write_var_summary_row(self,

2651

public,

2652

private,

2653

var,

2654

container)

2655

</h3>

2656

Write HTML code for a row in the variable summary table. Each row

2657

gives a brief description of a single variable.

2658

2659

<dl><dt>Parameters:</dt>

2660

<dd><code>public</code> -

2661

The output stream for the public version of the page.

2662

<dd><code>private</code> -

2663

The output stream for the private version of the page.

2664

<dd><code>var</code> -

2665

The variable that should be described by this row.

2666

</dd>

2667

</dl>

2668

</dd></dl>

2669

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

2670

2671

2672

2673

2674

2675

2676

<th colspan="2">Static Method Details</th></tr>

2677

</table>

2678

2679

2680

2681

<h3>format(object,

2682

error_stream=None,

2683

show_private=1,

2684

body_only=1,

2685

**options)

2686

</h3>

2687

2688

<dl><dt>Parameters:</dt>

2689

<dd><code>object</code> -

2690

The object to document. <code>object</code> can be a module, a

2691

class, a function, a method, or a property; or it can be the <a

2692

href="epydoc.uid.UID-class.html"

2693

class="link"><code>UID</code></a> of any object; or it can be a

2694

<a href="epydoc.uid.Link-class.html"

2695

class="link"><code>Link</code></a> to any object.

2696

<dd><code>error_stream</code> -

2697

A file or stream where errors and warnings will be written. If

2698

<code>error_stream</code> is unspecified, then warnings and

2699

errors are discarded.

2700

<dd><code>show_private</code> -

2701

If true, then include private objects in the output; if false,

2702

then only include public objects.

2703

<dd><code>body_only</code> -

2704

If true, then don't include navigation bars and breadcrumbs

2705

when generating the HTML documentation for a module or a class.

2706

If false, then do include them.

2707

<dd><code>options</code> -

2708

Options for the <code>HTMLFormatter</code> object that will be

2709

used to generate the HTML. See <a

2710

href="epydoc.html.HTMLFormatter-class.html#__init__"

2711

class="link"><code>HTMLFormatter.__init__</code></a> for a

2712

complete list of options.

2713

</dd>

2714

</dl>

2715

<dl><dt>Returns:</dt>

2716

<dd>

2717

A string containing the HTML documentation for the given

2718

object.

2719

</dd>

2720

</dl>

2721

</dd></dl>

2722

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

2723

2724

2725

2726

2727

2728

2729

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

2730

</table>

2731

2732

2733

<h3>_create_private_docs</h3>

2734

Whether or not to create documentation pages that include information

2735

about private objects.

2736

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

2737

2738

2739

2740

The name of a file containing a CSS stylesheet; or the name of a CSS

2741

stylesheet.

2742

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

2743

2744

2745

<h3>_docmap</h3>

2746

The documentation map, encoding the objects that should be

2747

documented.

2748

<dl>

2749

2750

<dd>

2751

<dl>

2752

2753

<dd>

2754

<a href="epydoc.objdoc.DocMap-class.html"

2755

class="link"><code>DocMap</code></a>

2756

2757

</dd>

2758

</dl>

2759

</dd>

2760

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

2761

2762

2763

<h3>_frames_index</h3>

2764

Whether or not to create a frames-based table of contents for the

2765

documentation.

2766

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

2767

2768

2769

2770

A name for the documentation (for the navbar).

2771

<dl>

2772

2773

<dd>

2774

<dl>

2775

2776

<dd>

2777

<code>string</code>

2778

2779

</dd>

2780

</dl>

2781

</dd>

2782

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

2783

2784

2785

2786

A URL for the documentation (for the navpar).

2787

<dl>

2788

2789

<dd>

2790

<dl>

2791

2792

<dd>

2793

<code>string</code>

2794

2795

</dd>

2796

</dl>

2797

</dd>

2798

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

2799

2800

2801

2802

The URI of the top page. This is the page shown in the main frame by

2803

the frames index; and the page that is used as the noframes index.

2804

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

2805

2806

2807

<h3>_variable_linelen</h3>

2808

The maximum line length used for displaying the values of variables in

2809

the variable details sections.

2810

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

2811

2812

2813

<h3>_variable_maxlines</h3>

2814

The maximum number of lines that should be displayed for the value of

2815

a variable in the variable details section.

2816

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

2817

2818

2819

<h3>_variable_tooltip_linelen</h3>

2820

The maximum line length for variable value tooltips.

2821

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

2822

2823

2824

2825

2826

2827

2828

2829

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

2830

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

2831

2832

2833

2834

2835

2836

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

2837

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

2838

</th>

2839

</tr>

2840

</table>

2841

2842

2843

<tr>

2844

<td align="left">Generated by Epydoc 2.1 on Sat Mar 20 17:46:11 2004</td>

2845

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

2846

>http://epydoc.sf.net</a></td>

2847

</tr>

2848

</table>

2849

</body>

2850

</html>

Older »