Skip to content

Commit

Permalink
added sdk documentation and generator script
Browse files Browse the repository at this point in the history
  • Loading branch information
KaiSchwarz-cnic committed Jul 9, 2018
1 parent a4bd960 commit 01fe1e0
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
41 changes: 41 additions & 0 deletions hexonet/apiconnector.html
@@ -0,0 +1,41 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package apiconnector</title>
<meta charset="utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>apiconnector</strong></big></big> (version 1.0.0)</font></td
><td align=right valign=bottom
><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>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>

<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="apiconnector.connection.html">connection</a><br>
</td><td width="25%" valign=top><a href="apiconnector.response.html">response</a><br>
</td><td width="25%" valign=top><a href="apiconnector.util.html">util</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>

<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<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>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>

<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>__version__</strong> = '1.0.0'<br>
<strong>name</strong> = 'apiconnector'</td></tr></table>
</body></html>
5 changes: 5 additions & 0 deletions scripts/pydoc.sh
@@ -0,0 +1,5 @@
#!/bin/bash
cd apiconnector
pydoc -w apiconnector
cd ..
git add hexonet/apiconnector.html

0 comments on commit 01fe1e0

Please sign in to comment.