Skip to content

Commit 01fe1e0

Browse files
added sdk documentation and generator script
1 parent a4bd960 commit 01fe1e0

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

hexonet/apiconnector.html

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3+
<html><head><title>Python: package apiconnector</title>
4+
<meta charset="utf-8">
5+
</head><body bgcolor="#f0f0f8">
6+
7+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
8+
<tr bgcolor="#7799ee">
9+
<td valign=bottom>&nbsp;<br>
10+
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>apiconnector</strong></big></big> (version 1.0.0)</font></td
11+
><td align=right valign=bottom
12+
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/kai/git/python-sdk/hexonet/apiconnector/__init__.py">/home/kai/git/python-sdk/hexonet/apiconnector/__init__.py</a></font></td></tr></table>
13+
<p></p>
14+
<p>
15+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
16+
<tr bgcolor="#aa55cc">
17+
<td colspan=3 valign=bottom>&nbsp;<br>
18+
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
19+
20+
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
21+
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="apiconnector.connection.html">connection</a><br>
22+
</td><td width="25%" valign=top><a href="apiconnector.response.html">response</a><br>
23+
</td><td width="25%" valign=top><a href="apiconnector.util.html">util</a><br>
24+
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
25+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
26+
<tr bgcolor="#eeaa77">
27+
<td colspan=3 valign=bottom>&nbsp;<br>
28+
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
29+
30+
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
31+
<td width="100%"><dl><dt><a name="-connect"><strong>connect</strong></a>(login<font color="#909090">=None</font>, password<font color="#909090">=None</font>, url<font color="#909090">=None</font>, entity<font color="#909090">=None</font>, user<font color="#909090">=None</font>, role<font color="#909090">=None</font>, config<font color="#909090">=None</font>)</dt><dd><tt>Returns&nbsp;an&nbsp;instance&nbsp;of&nbsp;apiconnector.Connection</tt></dd></dl>
32+
</td></tr></table><p>
33+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
34+
<tr bgcolor="#55aa55">
35+
<td colspan=3 valign=bottom>&nbsp;<br>
36+
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
37+
38+
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
39+
<td width="100%"><strong>__version__</strong> = '1.0.0'<br>
40+
<strong>name</strong> = 'apiconnector'</td></tr></table>
41+
</body></html>

scripts/pydoc.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/bash
2+
cd apiconnector
3+
pydoc -w apiconnector
4+
cd ..
5+
git add hexonet/apiconnector.html

0 commit comments

Comments
 (0)