Use html output of pydoc in api-python-client-doc application. Also g… · tmsoft/google-api-python-client@afc45f2 · GitHub
Skip to content

Commit afc45f2

Browse files
jcgregoriojcgregorio
committed
Use html output of pydoc in api-python-client-doc application. Also generate a static linked set of documents for all apis that we know about.
1 parent 55d5818 commit afc45f2

46 files changed

Lines changed: 1985 additions & 6 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Makefile‎

Lines changed: 1 addition & 0 deletions

‎describe.py‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import os
2+
import pydoc
3+
import re
4+
5+
from apiclient.discovery import build
6+
7+
BASE = 'docs/dyn'
8+
9+
APIS = [
10+
('buzz', 'v1'),
11+
('moderator', 'v1'),
12+
('latitude', 'v1'),
13+
('customsearch', 'v1'),
14+
('diacritize', 'v1'),
15+
('translate', 'v2'),
16+
('prediction', 'v1.1'),
17+
('shopping', 'v1'),
18+
('urlshortener', 'v1'),
19+
]
20+
21+
def document(resource, path):
22+
print path
23+
collections = []
24+
for name in dir(resource):
25+
if not "_" in name and callable(getattr(resource, name)) and hasattr(
26+
getattr(resource, name), '__is_resource__'):
27+
collections.append(name)
28+
29+
obj, name = pydoc.resolve(type(resource))
30+
page = pydoc.html.page(
31+
pydoc.describe(obj), pydoc.html.document(obj, name))
32+
33+
for name in collections:
34+
page = re.sub('strong>(%s)<' % name, r'strong><a href="%s">\1</a><' % (path + name + ".html"), page)
35+
for name in collections:
36+
document(getattr(resource, name)(), path + name + ".")
37+
38+
f = open(os.path.join(BASE, path + 'html'), 'w')
39+
f.write(page)
40+
f.close()
41+
42+
def document_api(name, version):
43+
service = build(name, version)
44+
document(service, '%s.%s.' % (name, version))
45+
46+
if __name__ == '__main__':
47+
for name, version in APIS:
48+
document_api(name, version)
49+

‎docs/dyn/buzz.v1.activities.html‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3+
<html><head><title>Python: class Resource</title>
4+
</head><body bgcolor="#f0f0f8">
5+
<p>
6+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7+
<tr bgcolor="#ffc8d8">
8+
<td colspan=3 valign=bottom>&nbsp;<br>
9+
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10+
11+
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12+
<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13+
<tr><td>&nbsp;</td>
14+
<td width="100%">Methods defined here:<br>
15+
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16+
17+
<dl><dt><a name="Resource-count"><strong>count</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;count&nbsp;of&nbsp;link&nbsp;shares<br>
18+
&nbsp;<br>
19+
Args:<br>
20+
&nbsp;&nbsp;url:&nbsp;URLs&nbsp;for&nbsp;which&nbsp;to&nbsp;get&nbsp;share&nbsp;counts.<br>
21+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.</tt></dd></dl>
22+
23+
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete&nbsp;an&nbsp;activity<br>
24+
&nbsp;<br>
25+
Args:<br>
26+
&nbsp;&nbsp;scope:&nbsp;The&nbsp;collection&nbsp;to&nbsp;which&nbsp;the&nbsp;activity&nbsp;belongs.&nbsp;(required)<br>
27+
&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
28+
&nbsp;&nbsp;postId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;delete.&nbsp;(required)<br>
29+
&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;post&nbsp;to&nbsp;delete.&nbsp;(required)<br>
30+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.</tt></dd></dl>
31+
32+
<dl><dt><a name="Resource-extractPeopleFromSearch"><strong>extractPeopleFromSearch</strong></a> = method(self, **kwargs)</dt><dd><tt>Search&nbsp;for&nbsp;people&nbsp;by&nbsp;topic<br>
33+
&nbsp;<br>
34+
Args:<br>
35+
&nbsp;&nbsp;c:&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
36+
&nbsp;&nbsp;pid:&nbsp;ID&nbsp;of&nbsp;a&nbsp;place&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
37+
&nbsp;&nbsp;lon:&nbsp;Longitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
38+
&nbsp;&nbsp;q:&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.<br>
39+
&nbsp;&nbsp;max_results:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
40+
&nbsp;&nbsp;radius:&nbsp;Radius&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
41+
&nbsp;&nbsp;bbox:&nbsp;Bounding&nbsp;box&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
42+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
43+
&nbsp;&nbsp;lat:&nbsp;Latitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
44+
&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.</tt></dd></dl>
45+
46+
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;an&nbsp;activity<br>
47+
&nbsp;<br>
48+
Args:<br>
49+
&nbsp;&nbsp;postId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;get.&nbsp;(required)<br>
50+
&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;post&nbsp;to&nbsp;get.&nbsp;(required)<br>
51+
&nbsp;&nbsp;truncateAtom:&nbsp;Truncate&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;atom:content&nbsp;element.<br>
52+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
53+
&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
54+
&nbsp;&nbsp;max_comments:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;comments&nbsp;to&nbsp;include.<br>
55+
&nbsp;&nbsp;max_liked:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;likes&nbsp;to&nbsp;include.</tt></dd></dl>
56+
57+
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;activity<br>
58+
&nbsp;<br>
59+
Args:<br>
60+
&nbsp;&nbsp;body:&nbsp;The&nbsp;request&nbsp;body.<br>
61+
&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
62+
&nbsp;&nbsp;preview:&nbsp;If&nbsp;true,&nbsp;only&nbsp;preview&nbsp;the&nbsp;action.<br>
63+
&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
64+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.</tt></dd></dl>
65+
66+
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;activities<br>
67+
&nbsp;<br>
68+
Args:<br>
69+
&nbsp;&nbsp;c:&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
70+
&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
71+
&nbsp;&nbsp;truncateAtom:&nbsp;Truncate&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;atom:content&nbsp;element.<br>
72+
&nbsp;&nbsp;max_results:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
73+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
74+
&nbsp;&nbsp;scope:&nbsp;The&nbsp;collection&nbsp;of&nbsp;activities&nbsp;to&nbsp;list.&nbsp;(required)<br>
75+
&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
76+
&nbsp;&nbsp;max_comments:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;comments&nbsp;to&nbsp;include.<br>
77+
&nbsp;&nbsp;max_liked:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;likes&nbsp;to&nbsp;include.</tt></dd></dl>
78+
79+
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes&nbsp;a&nbsp;single&nbsp;argument,&nbsp;'body',&nbsp;which&nbsp;is&nbsp;the&nbsp;results<br>
80+
from&nbsp;the&nbsp;last&nbsp;call,&nbsp;and&nbsp;returns&nbsp;the&nbsp;next&nbsp;set&nbsp;of&nbsp;items<br>
81+
in&nbsp;the&nbsp;collection.<br>
82+
&nbsp;<br>
83+
Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in<br>
84+
the&nbsp;collection.</tt></dd></dl>
85+
86+
<dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search&nbsp;for&nbsp;activities<br>
87+
&nbsp;<br>
88+
Args:<br>
89+
&nbsp;&nbsp;c:&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
90+
&nbsp;&nbsp;pid:&nbsp;ID&nbsp;of&nbsp;a&nbsp;place&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
91+
&nbsp;&nbsp;lon:&nbsp;Longitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
92+
&nbsp;&nbsp;q:&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.<br>
93+
&nbsp;&nbsp;truncateAtom:&nbsp;Truncate&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;atom:content&nbsp;element.<br>
94+
&nbsp;&nbsp;max_results:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
95+
&nbsp;&nbsp;radius:&nbsp;Radius&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
96+
&nbsp;&nbsp;bbox:&nbsp;Bounding&nbsp;box&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
97+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
98+
&nbsp;&nbsp;lat:&nbsp;Latitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
99+
&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.</tt></dd></dl>
100+
101+
<dl><dt><a name="Resource-search_next"><strong>search_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes&nbsp;a&nbsp;single&nbsp;argument,&nbsp;'body',&nbsp;which&nbsp;is&nbsp;the&nbsp;results<br>
102+
from&nbsp;the&nbsp;last&nbsp;call,&nbsp;and&nbsp;returns&nbsp;the&nbsp;next&nbsp;set&nbsp;of&nbsp;items<br>
103+
in&nbsp;the&nbsp;collection.<br>
104+
&nbsp;<br>
105+
Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in<br>
106+
the&nbsp;collection.</tt></dd></dl>
107+
108+
<dl><dt><a name="Resource-track"><strong>track</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;real-time&nbsp;activity&nbsp;tracking&nbsp;information<br>
109+
&nbsp;<br>
110+
Args:<br>
111+
&nbsp;&nbsp;c:&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
112+
&nbsp;&nbsp;pid:&nbsp;ID&nbsp;of&nbsp;a&nbsp;place&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
113+
&nbsp;&nbsp;lon:&nbsp;Longitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
114+
&nbsp;&nbsp;q:&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.<br>
115+
&nbsp;&nbsp;max_results:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
116+
&nbsp;&nbsp;radius:&nbsp;Radius&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
117+
&nbsp;&nbsp;bbox:&nbsp;Bounding&nbsp;box&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
118+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
119+
&nbsp;&nbsp;lat:&nbsp;Latitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
120+
&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.</tt></dd></dl>
121+
122+
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update&nbsp;an&nbsp;activity<br>
123+
&nbsp;<br>
124+
Args:<br>
125+
&nbsp;&nbsp;body:&nbsp;The&nbsp;request&nbsp;body.<br>
126+
&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;post&nbsp;to&nbsp;update.&nbsp;(required)<br>
127+
&nbsp;&nbsp;abuseType:&nbsp;A&nbsp;parameter<br>
128+
&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
129+
&nbsp;&nbsp;scope:&nbsp;The&nbsp;collection&nbsp;to&nbsp;which&nbsp;the&nbsp;activity&nbsp;belongs.&nbsp;(required)<br>
130+
&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
131+
&nbsp;&nbsp;postId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;update.&nbsp;(required)</tt></dd></dl>
132+
133+
<hr>
134+
Data descriptors defined here:<br>
135+
<dl><dt><strong>__dict__</strong></dt>
136+
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
137+
</dl>
138+
<dl><dt><strong>__weakref__</strong></dt>
139+
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
140+
</dl>
141+
</td></tr></table>
142+
</body></html>

‎docs/dyn/buzz.v1.comments.html‎

Lines changed: 76 additions & 0 deletions

0 commit comments

Comments
 (0)