py_tasks_melange: thirdparty/python-graph/docs/help.html@06c2228e39cb (annotated)

594 06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	1	<?xml version="1.0" encoding="ascii"?>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	3	"DTD/xhtml1-transitional.dtd">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	4	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	5	<head>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	6	<title>Help</title>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	7	<link rel="stylesheet" href="epydoc.css" type="text/css" />
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	8	<script type="text/javascript" src="epydoc.js"></script>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	9	</head>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	10
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	11	<body bgcolor="white" text="black" link="blue" vlink="#204080"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	12	alink="#204080">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	13	<!-- ==================== NAVIGATION BAR ==================== -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	14	<table class="navbar" border="0" width="100%" cellpadding="0"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	15	bgcolor="#a0c0ff" cellspacing="0">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	16	<tr valign="middle">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	17	<!-- Home link -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	18	<th>   <a
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	19	href="graph-module.html">Home</a>   </th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	20
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	21	<!-- Tree link -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	22	<th>   <a
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	23	href="module-tree.html">Trees</a>   </th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	24
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	25	<!-- Index link -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	26	<th>   <a
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	27	href="identifier-index.html">Indices</a>   </th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	28
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	29	<!-- Help link -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	30	<th bgcolor="#70b0f0" class="navbar-select"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	31	>   Help   </th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	32
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	33	<!-- Project homepage -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	34	<th class="navbar" align="right" width="100%">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	35	<table border="0" cellpadding="0" cellspacing="0">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	36	<tr><th class="navbar" align="center"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	37	><a class="navbar" target="_top" href="http://code.google.com/p/python-graph/">python-graph</a></th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	38	</tr></table></th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	39	</tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	40	</table>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	41	<table width="100%" cellpadding="0" cellspacing="0">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	42	<tr valign="top">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	43	<td width="100%"> </td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	44	<td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	45	<table cellpadding="0" cellspacing="0">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	46	<!-- hide/show private -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	47	</table>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	48	</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	49	</tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	50	</table>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	51
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	52	<h1 class="epydoc"> API Documentation </h1>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	53
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	54	<p> This document contains the API (Application Programming Interface)
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	55	documentation for python-graph. Documentation for the Python
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	56	objects defined by the project is divided into separate pages for each
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	57	package, module, and class. The API documentation also includes two
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	58	pages containing information about the project as a whole: a trees
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	59	page, and an index page. </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	60
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	61	<h2> Object Documentation </h2>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	62
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	63	<p>Each <strong>Package Documentation</strong> page contains: </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	64	<ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	65	<li> A description of the package. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	66	<li> A list of the modules and sub-packages contained by the
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	67	package. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	68	<li> A summary of the classes defined by the package. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	69	<li> A summary of the functions defined by the package. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	70	<li> A summary of the variables defined by the package. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	71	<li> A detailed description of each function defined by the
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	72	package. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	73	<li> A detailed description of each variable defined by the
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	74	package. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	75	</ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	76
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	77	<p>Each <strong>Module Documentation</strong> page contains:</p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	78	<ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	79	<li> A description of the module. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	80	<li> A summary of the classes defined by the module. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	81	<li> A summary of the functions defined by the module. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	82	<li> A summary of the variables defined by the module. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	83	<li> A detailed description of each function defined by the
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	84	module. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	85	<li> A detailed description of each variable defined by the
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	86	module. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	87	</ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	88
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	89	<p>Each <strong>Class Documentation</strong> page contains: </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	90	<ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	91	<li> A class inheritance diagram. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	92	<li> A list of known subclasses. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	93	<li> A description of the class. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	94	<li> A summary of the methods defined by the class. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	95	<li> A summary of the instance variables defined by the class. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	96	<li> A summary of the class (static) variables defined by the
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	97	class. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	98	<li> A detailed description of each method defined by the
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	99	class. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	100	<li> A detailed description of each instance variable defined by the
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	101	class. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	102	<li> A detailed description of each class (static) variable defined
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	103	by the class. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	104	</ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	105
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	106	<h2> Project Documentation </h2>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	107
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	108	<p> The <strong>Trees</strong> page contains the module and class hierarchies: </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	109	<ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	110	<li> The <em>module hierarchy</em> lists every package and module, with
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	111	modules grouped into packages. At the top level, and within each
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	112	package, modules and sub-packages are listed alphabetically. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	113	<li> The <em>class hierarchy</em> lists every class, grouped by base
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	114	class. If a class has more than one base class, then it will be
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	115	listed under each base class. At the top level, and under each base
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	116	class, classes are listed alphabetically. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	117	</ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	118
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	119	<p> The <strong>Index</strong> page contains indices of terms and
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	120	identifiers: </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	121	<ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	122	<li> The <em>term index</em> lists every term indexed by any object's
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	123	documentation. For each term, the index provides links to each
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	124	place where the term is indexed. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	125	<li> The <em>identifier index</em> lists the (short) name of every package,
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	126	module, class, method, function, variable, and parameter. For each
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	127	identifier, the index provides a short description, and a link to
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	128	its documentation. </li>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	129	</ul>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	130
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	131	<h2> The Table of Contents </h2>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	132
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	133	<p> The table of contents occupies the two frames on the left side of
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	134	the window. The upper-left frame displays the <em>project
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	135	contents</em>, and the lower-left frame displays the <em>module
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	136	contents</em>: </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	137
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	138	<table class="help summary" border="1" cellspacing="0" cellpadding="3">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	139	<tr style="height: 30%">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	140	<td align="center" style="font-size: small">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	141	Project<br />Contents<hr />...</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	142	<td align="center" style="font-size: small" rowspan="2" width="70%">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	143	API<br />Documentation<br />Frame<br /><br /><br />
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	144	</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	145	</tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	146	<tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	147	<td align="center" style="font-size: small">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	148	Module<br />Contents<hr /> <br />...<br />
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	149	</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	150	</tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	151	</table><br />
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	152
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	153	<p> The <strong>project contents frame</strong> contains a list of all packages
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	154	and modules that are defined by the project. Clicking on an entry
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	155	will display its contents in the module contents frame. Clicking on a
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	156	special entry, labeled "Everything," will display the contents of
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	157	the entire project. </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	158
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	159	<p> The <strong>module contents frame</strong> contains a list of every
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	160	submodule, class, type, exception, function, and variable defined by a
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	161	module or package. Clicking on an entry will display its
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	162	documentation in the API documentation frame. Clicking on the name of
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	163	the module, at the top of the frame, will display the documentation
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	164	for the module itself. </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	165
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	166	<p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	167	navigation bar can be used to control whether the table of contents is
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	168	displayed or not. </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	169
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	170	<h2> The Navigation Bar </h2>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	171
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	172	<p> A navigation bar is located at the top and bottom of every page.
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	173	It indicates what type of page you are currently viewing, and allows
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	174	you to go to related pages. The following table describes the labels
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	175	on the navigation bar. Note that not some labels (such as
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	176	[Parent]) are not displayed on all pages. </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	177
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	178	<table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	179	<tr class="summary">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	180	<th>Label</th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	181	<th>Highlighted when...</th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	182	<th>Links to...</th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	183	</tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	184	<tr><td valign="top"><strong>[Parent]</strong></td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	185	<td valign="top"><em>(never highlighted)</em></td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	186	<td valign="top"> the parent of the current package </td></tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	187	<tr><td valign="top"><strong>[Package]</strong></td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	188	<td valign="top">viewing a package</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	189	<td valign="top">the package containing the current object
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	190	</td></tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	191	<tr><td valign="top"><strong>[Module]</strong></td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	192	<td valign="top">viewing a module</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	193	<td valign="top">the module containing the current object
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	194	</td></tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	195	<tr><td valign="top"><strong>[Class]</strong></td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	196	<td valign="top">viewing a class </td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	197	<td valign="top">the class containing the current object</td></tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	198	<tr><td valign="top"><strong>[Trees]</strong></td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	199	<td valign="top">viewing the trees page</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	200	<td valign="top"> the trees page </td></tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	201	<tr><td valign="top"><strong>[Index]</strong></td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	202	<td valign="top">viewing the index page</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	203	<td valign="top"> the index page </td></tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	204	<tr><td valign="top"><strong>[Help]</strong></td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	205	<td valign="top">viewing the help page</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	206	<td valign="top"> the help page </td></tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	207	</table>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	208
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	209	<p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	210	the top navigation bar can be used to control whether documentation
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	211	for private objects is displayed. Private objects are usually defined
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	212	as objects whose (short) names begin with a single underscore, but do
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	213	not end with an underscore. For example, "<code>_x</code>",
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	214	"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	215	are private objects; but "<code>re.sub</code>",
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	216	"<code>__init__</code>", and "<code>type_</code>" are not. However,
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	217	if a module defines the "<code>__all__</code>" variable, then its
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	218	contents are used to decide which objects are private. </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	219
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	220	<p> A timestamp below the bottom navigation bar indicates when each
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	221	page was last updated. </p>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	222	<!-- ==================== NAVIGATION BAR ==================== -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	223	<table class="navbar" border="0" width="100%" cellpadding="0"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	224	bgcolor="#a0c0ff" cellspacing="0">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	225	<tr valign="middle">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	226	<!-- Home link -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	227	<th>   <a
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	228	href="graph-module.html">Home</a>   </th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	229
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	230	<!-- Tree link -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	231	<th>   <a
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	232	href="module-tree.html">Trees</a>   </th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	233
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	234	<!-- Index link -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	235	<th>   <a
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	236	href="identifier-index.html">Indices</a>   </th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	237
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	238	<!-- Help link -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	239	<th bgcolor="#70b0f0" class="navbar-select"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	240	>   Help   </th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	241
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	242	<!-- Project homepage -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	243	<th class="navbar" align="right" width="100%">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	244	<table border="0" cellpadding="0" cellspacing="0">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	245	<tr><th class="navbar" align="center"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	246	><a class="navbar" target="_top" href="http://code.google.com/p/python-graph/">python-graph</a></th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	247	</tr></table></th>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	248	</tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	249	</table>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	250	<table border="0" cellpadding="0" cellspacing="0" width="100%%">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	251	<tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	252	<td align="left" class="footer">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	253	Generated by Epydoc 3.0.1 on Mon Oct 27 20:36:37 2008
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	254	</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	255	<td align="right" class="footer">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	256	<a target="mainFrame" href="http://epydoc.sourceforge.net"
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	257	>http://epydoc.sourceforge.net</a>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	258	</td>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	259	</tr>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	260	</table>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	261
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	262	<script type="text/javascript">
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	263	<!--
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	264	// Private objects are initially displayed (because if
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	265	// javascript is turned off then we want them to be
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	266	// visible); but by default, we want to hide them. So hide
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	267	// them unless we have a cookie that says to show them.
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	268	checkCookie();
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	269	// -->
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	270	</script>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	271	</body>
06c2228e39cb Added the python-graph module Sverre Rabbelier <srabbelier@gmail.com> parents: diff changeset	272	</html>

author	Sverre Rabbelier <srabbelier@gmail.com>
	Wed, 26 Nov 2008 23:56:19 +0000
changeset 594	06c2228e39cb
permissions	-rw-r--r--