Skip to content

Commit

Permalink
Generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
viktoriia-yuzkiv committed May 26, 2017
1 parent 6629a58 commit adfb591
Show file tree
Hide file tree
Showing 8 changed files with 438 additions and 116 deletions.
73 changes: 73 additions & 0 deletions documentation/modules.an_array.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module modules.an_array</title>
<meta http-equiv="Content-Type" content="text/html; 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><a href="modules.html"><font color="#ffffff">modules</font></a>.an_array</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cusers%5Cuser1%5Cdocuments%5Cstudy%20hard%5Cprogramming%5Ccoursework2017%5Cmodules%5Can_array.py">c:\users\user1\documents\study hard\programming\coursework2017\modules\an_array.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>Modules</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="ctypes.html">ctypes</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></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="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="modules.an_array.html#AnArray">AnArray</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="AnArray">class <strong>AnArray</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>

<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Creates&nbsp;an&nbsp;array&nbsp;and&nbsp;gives&nbsp;some&nbsp;tools&nbsp;to&nbsp;work&nbsp;with&nbsp;it.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="AnArray-__getitem__"><strong>__getitem__</strong></a>(self, index)</dt><dd><tt>Gets&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;element.<br>
&nbsp;<br>
:param&nbsp;index:&nbsp;the&nbsp;index&nbsp;of&nbsp;element.<br>
:return:&nbsp;value&nbsp;of&nbsp;the&nbsp;element.</tt></dd></dl>

<dl><dt><a name="AnArray-__init__"><strong>__init__</strong></a>(self, size)</dt><dd><tt>Creates&nbsp;an&nbsp;array&nbsp;with&nbsp;the&nbsp;length&nbsp;size.<br>
&nbsp;<br>
:param&nbsp;size:&nbsp;the&nbsp;size&nbsp;of&nbsp;the&nbsp;array.</tt></dd></dl>

<dl><dt><a name="AnArray-__len__"><strong>__len__</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;length&nbsp;of&nbsp;the&nbsp;array.<br>
&nbsp;<br>
:return:&nbsp;the&nbsp;size&nbsp;of&nbsp;the&nbsp;array.</tt></dd></dl>

<dl><dt><a name="AnArray-__setitem__"><strong>__setitem__</strong></a>(self, index, value)</dt><dd><tt>Puts&nbsp;the&nbsp;value&nbsp;in&nbsp;the&nbsp;array&nbsp;element&nbsp;at&nbsp;index&nbsp;position.<br>
&nbsp;<br>
:param&nbsp;index:&nbsp;the&nbsp;index&nbsp;element.<br>
:param&nbsp;value:&nbsp;the&nbsp;value&nbsp;of&nbsp;element.</tt></dd></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table>
</body></html>
96 changes: 96 additions & 0 deletions documentation/modules.my_research.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module modules.my_research</title>
<meta http-equiv="Content-Type" content="text/html; 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><a href="modules.html"><font color="#ffffff">modules</font></a>.my_research</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cusers%5Cuser1%5Cdocuments%5Cstudy%20hard%5Cprogramming%5Ccoursework2017%5Cmodules%5Cmy_research.py">c:\users\user1\documents\study hard\programming\coursework2017\modules\my_research.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="modules.my_research.html#MainResearch">MainResearch</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="MainResearch">class <strong>MainResearch</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>

<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>This&nbsp;class&nbsp;represents&nbsp;methods&nbsp;which&nbsp;help&nbsp;to&nbsp;do&nbsp;some&nbsp;research.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="MainResearch-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Reads&nbsp;the&nbsp;information&nbsp;from&nbsp;a&nbsp;file.<br>
Makes&nbsp;an&nbsp;array&nbsp;which&nbsp;contains&nbsp;that&nbsp;information.</tt></dd></dl>

<dl><dt><a name="MainResearch-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>Creates&nbsp;a&nbsp;string&nbsp;with&nbsp;series&nbsp;titles.<br>
&nbsp;<br>
:return:&nbsp;a&nbsp;string&nbsp;with&nbsp;series&nbsp;titles</tt></dd></dl>

<dl><dt><a name="MainResearch-popular_actors"><strong>popular_actors</strong></a>(self)</dt><dd><tt>Creates&nbsp;a&nbsp;dictionary.&nbsp;Gets&nbsp;the&nbsp;information&nbsp;about&nbsp;all<br>
actors&nbsp;from&nbsp;given&nbsp;series&nbsp;and&nbsp;adds&nbsp;it&nbsp;to&nbsp;the&nbsp;dictionary<br>
(key&nbsp;-&nbsp;the&nbsp;name&nbsp;of&nbsp;an&nbsp;actor/actress,&nbsp;value&nbsp;-&nbsp;the&nbsp;number&nbsp;of&nbsp;series<br>
in&nbsp;which&nbsp;that&nbsp;actor/actress&nbsp;performed).<br>
&nbsp;<br>
:return:&nbsp;a&nbsp;dictionary&nbsp;(key&nbsp;-&nbsp;the&nbsp;name&nbsp;of&nbsp;an&nbsp;actor/actress,&nbsp;value&nbsp;-<br>
the&nbsp;number&nbsp;of&nbsp;series&nbsp;in&nbsp;which&nbsp;that&nbsp;actor/actress&nbsp;performed)</tt></dd></dl>

<dl><dt><a name="MainResearch-series_seasons"><strong>series_seasons</strong></a>(self)</dt><dd><tt>Creates&nbsp;a&nbsp;dictionary.&nbsp;Gets&nbsp;the&nbsp;information&nbsp;about&nbsp;number&nbsp;of&nbsp;seasons<br>
in&nbsp;series&nbsp;adds&nbsp;it&nbsp;to&nbsp;the&nbsp;dictionary&nbsp;(key&nbsp;-&nbsp;series&nbsp;title,&nbsp;value&nbsp;-&nbsp;the&nbsp;number<br>
of&nbsp;seasons).<br>
&nbsp;<br>
:return:&nbsp;a&nbsp;dictionary&nbsp;(key&nbsp;-&nbsp;series&nbsp;title,&nbsp;value&nbsp;-&nbsp;the&nbsp;number&nbsp;of&nbsp;seasons).</tt></dd></dl>

<dl><dt><a name="MainResearch-series_titles"><strong>series_titles</strong></a>(self)</dt><dd><tt>Creates&nbsp;a&nbsp;dictionary.&nbsp;Gets&nbsp;every&nbsp;word&nbsp;from&nbsp;series&nbsp;titles&nbsp;and&nbsp;adds&nbsp;it<br>
to&nbsp;the&nbsp;dictionary(key&nbsp;-&nbsp;word,&nbsp;value&nbsp;-&nbsp;the&nbsp;number&nbsp;of&nbsp;repetition&nbsp;in<br>
series&nbsp;titles).<br>
&nbsp;<br>
:return:&nbsp;the&nbsp;dictionary(key&nbsp;-&nbsp;word,&nbsp;value&nbsp;-&nbsp;the&nbsp;number&nbsp;of<br>
repetition&nbsp;in&nbsp;series&nbsp;titles).</tt></dd></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</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="-main"><strong>main</strong></a>()</dt><dd><tt>Makes&nbsp;the&nbsp;main&nbsp;research.</tt></dd></dl>
<dl><dt><a name="-save_info"><strong>save_info</strong></a>(info, filename)</dt><dd><tt>Creates&nbsp;a&nbsp;new&nbsp;file&nbsp;with&nbsp;a&nbsp;name&nbsp;filename.<br>
Writes&nbsp;the&nbsp;information&nbsp;from&nbsp;info&nbsp;into&nbsp;this&nbsp;file.<br>
&nbsp;<br>
:param&nbsp;info:&nbsp;a&nbsp;list&nbsp;of&nbsp;tuples&nbsp;with&nbsp;the&nbsp;information<br>
that&nbsp;should&nbsp;be&nbsp;saved.<br>
:param&nbsp;filename:&nbsp;a&nbsp;name&nbsp;of&nbsp;a&nbsp;created&nbsp;file.</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>__warningregistry__</strong> = {("unclosed file &lt;_io.TextIOWrapper name='series_seasons.txt' mode='w' encoding='cp1251'&gt;", &lt;class 'ResourceWarning'&gt;, 123): True, ("unclosed file &lt;_io.TextIOWrapper name='popular_actors.txt' mode='w' encoding='cp1251'&gt;", &lt;class 'ResourceWarning'&gt;, 118): True, ("unclosed file &lt;_io.TextIOWrapper name='ratings.txt' mode='r' encoding='utf-8'&gt;", &lt;class 'ResourceWarning'&gt;, 16): True, 'version': 0, ("unclosed file &lt;_io.TextIOWrapper name='series_titles.txt' mode='w' encoding='cp1251'&gt;", &lt;class 'ResourceWarning'&gt;, 129): True}</td></tr></table>
</body></html>
93 changes: 93 additions & 0 deletions documentation/modules.series_research.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module modules.series_research</title>
<meta http-equiv="Content-Type" content="text/html; 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><a href="modules.html"><font color="#ffffff">modules</font></a>.series_research</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cusers%5Cuser1%5Cdocuments%5Cstudy%20hard%5Cprogramming%5Ccoursework2017%5Cmodules%5Cseries_research.py">c:\users\user1\documents\study hard\programming\coursework2017\modules\series_research.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>Modules</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="pytvdbapi.api.html">pytvdbapi.api</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></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="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="modules.series_research.html#SeriesResearch">SeriesResearch</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="SeriesResearch">class <strong>SeriesResearch</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>

<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Implements&nbsp;the&nbsp;<a href="#SeriesResearch">SeriesResearch</a>&nbsp;ADT&nbsp;for&nbsp;doing<br>
research&nbsp;based&nbsp;of&nbsp;the&nbsp;information&nbsp;about&nbsp;series.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="SeriesResearch-__init__"><strong>__init__</strong></a>(self, length)</dt><dd><tt>Creates&nbsp;an&nbsp;array.<br>
&nbsp;<br>
:param&nbsp;length:&nbsp;the&nbsp;length&nbsp;of&nbsp;a&nbsp;created&nbsp;array.</tt></dd></dl>

<dl><dt><a name="SeriesResearch-find_len"><strong>find_len</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;length&nbsp;of&nbsp;the&nbsp;array.<br>
&nbsp;<br>
:return:&nbsp;the&nbsp;size&nbsp;of&nbsp;the&nbsp;array.</tt></dd></dl>

<dl><dt><a name="SeriesResearch-get_actors"><strong>get_actors</strong></a>(self, index)</dt><dd><tt>Gets&nbsp;actors&nbsp;from&nbsp;series&nbsp;(the&nbsp;value&nbsp;of&nbsp;the&nbsp;element&nbsp;is<br>
the&nbsp;name&nbsp;of&nbsp;series).<br>
&nbsp;<br>
:param&nbsp;index:&nbsp;the&nbsp;index&nbsp;of&nbsp;the&nbsp;element.<br>
:return:&nbsp;the&nbsp;list&nbsp;of&nbsp;actors.</tt></dd></dl>

<dl><dt><a name="SeriesResearch-get_item"><strong>get_item</strong></a>(self, index)</dt><dd><tt>Gets&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;element.<br>
&nbsp;<br>
:param&nbsp;index:&nbsp;the&nbsp;index&nbsp;of&nbsp;the&nbsp;element.<br>
:return:&nbsp;value&nbsp;of&nbsp;the&nbsp;element.</tt></dd></dl>

<dl><dt><a name="SeriesResearch-seasons_number"><strong>seasons_number</strong></a>(self, index)</dt><dd><tt>Gets&nbsp;the&nbsp;number&nbsp;of&nbsp;seasons&nbsp;in&nbsp;the&nbsp;given&nbsp;series<br>
(the&nbsp;value&nbsp;of&nbsp;the&nbsp;element&nbsp;is&nbsp;the&nbsp;name&nbsp;of&nbsp;series).<br>
&nbsp;<br>
:param&nbsp;index:&nbsp;the&nbsp;index&nbsp;of&nbsp;the&nbsp;element.<br>
:return:&nbsp;the&nbsp;number&nbsp;of&nbsp;seasons.</tt></dd></dl>

<dl><dt><a name="SeriesResearch-set_item"><strong>set_item</strong></a>(self, index, value)</dt><dd><tt>Puts&nbsp;the&nbsp;value&nbsp;in&nbsp;the&nbsp;array&nbsp;element&nbsp;at&nbsp;index&nbsp;position.<br>
&nbsp;<br>
:param&nbsp;index:&nbsp;the&nbsp;index&nbsp;the&nbsp;element.<br>
:param&nbsp;value:&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;element.</tt></dd></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table></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>db</strong> = &lt;pytvdbapi.api.TVDB object&gt;</td></tr></table>
</body></html>
Loading

0 comments on commit adfb591

Please sign in to comment.