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