dh1tw/pyhamtools
1
0
Fork 0
mirror of https://github.com/dh1tw/pyhamtools.git synced 2026-01-18 14:40:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated html documentation files

Browse source
This commit is contained in:
dh1tw 2014-09-21 20:20:37 +02:00
parent c37b69d6ed
commit 9a0c9cefba
19 changed files with 118 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/build/doctrees/Callinfo.doctree vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/environment.pickle vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/help.doctree vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/index.doctree vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/license.doctree vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/lookuplib.doctree vendored
View file

Binary file not shown.

2
docs/build/html/.buildinfo vendored
View file

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 841ebbf79ca7b9d13ea1507ed2540934
config: 600f158a9e0f0243044c536b465c44c7
tags: 645f666f9bcd5a90fca523b33c5a78b7

38
docs/build/html/Callinfo.html vendored
View file

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Callinfo &mdash; pyhamtools 0.3.1 documentation</title>
<title>Callinfo &mdash; pyhamtools 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
VERSION: '0.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,9 +23,9 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyhamtools 0.3.1 documentation" href="index.html" />
<link rel="top" title="pyhamtools 0.4.0 documentation" href="index.html" />
<link rel="next" title="LookupLib" href="LookupLib.html" />
<link rel="prev" title="utils" href="utils.html" />
<link rel="prev" title="locator" href="locator.html" />
</head>
<body>
<div class="related">
@ -41,9 +41,9 @@
<a href="LookupLib.html" title="LookupLib"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="utils.html" title="utils"
<a href="locator.html" title="locator"
accesskey="P">previous</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -79,7 +79,7 @@ An instance of <tt class="xref py py-class docutils literal"><span class="pre">L
</table>
<dl class="method">
<dt id="pyhamtools.callinfo.Callinfo.get_adif_id">
<tt class="descname">get_adif_id</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>27244</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_adif_id" title="Permalink to this definition"></a></dt>
<tt class="descname">get_adif_id</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>397379</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_adif_id" title="Permalink to this definition"></a></dt>
<dd><p>Returns ADIF id of a callsign&#8217;s country</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -107,7 +107,7 @@ No Country found for callsign</p>
<dl class="method">
<dt id="pyhamtools.callinfo.Callinfo.get_all">
<tt class="descname">get_all</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>27244</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_all" title="Permalink to this definition"></a></dt>
<tt class="descname">get_all</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>397379</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_all" title="Permalink to this definition"></a></dt>
<dd><p>Lookup a callsign and return all data available from the underlying database</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -160,7 +160,7 @@ would be missing with Clublog (API or XML) <tt class="xref py py-class docutils
<dl class="method">
<dt id="pyhamtools.callinfo.Callinfo.get_continent">
<tt class="descname">get_continent</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>27244</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_continent" title="Permalink to this definition"></a></dt>
<tt class="descname">get_continent</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>397379</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_continent" title="Permalink to this definition"></a></dt>
<dd><p>Returns the continent Identifier of a callsign</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -201,7 +201,7 @@ No Continent found for callsign</p>
<dl class="method">
<dt id="pyhamtools.callinfo.Callinfo.get_country_name">
<tt class="descname">get_country_name</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>27244</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_country_name" title="Permalink to this definition"></a></dt>
<tt class="descname">get_country_name</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>397379</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_country_name" title="Permalink to this definition"></a></dt>
<dd><p>Returns the country name where the callsign is located</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -239,7 +239,7 @@ for countries. Example:</p>
<dl class="method">
<dt id="pyhamtools.callinfo.Callinfo.get_cqz">
<tt class="descname">get_cqz</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>27244</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_cqz" title="Permalink to this definition"></a></dt>
<tt class="descname">get_cqz</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>397379</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_cqz" title="Permalink to this definition"></a></dt>
<dd><p>Returns CQ Zone of a callsign</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -297,7 +297,7 @@ No callsign found in string</td>
<dl class="method">
<dt id="pyhamtools.callinfo.Callinfo.get_ituz">
<tt class="descname">get_ituz</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>27244</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_ituz" title="Permalink to this definition"></a></dt>
<tt class="descname">get_ituz</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>397379</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_ituz" title="Permalink to this definition"></a></dt>
<dd><p>Returns ITU Zone of a callsign</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -329,7 +329,7 @@ No ITU Zone found for callsign</p>
<dl class="method">
<dt id="pyhamtools.callinfo.Callinfo.get_lat_long">
<tt class="descname">get_lat_long</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>27244</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_lat_long" title="Permalink to this definition"></a></dt>
<tt class="descname">get_lat_long</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>397379</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.get_lat_long" title="Permalink to this definition"></a></dt>
<dd><p>Returns Latitude and Longitude for a callsign</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -375,7 +375,7 @@ dedicated entry in the database exists.</p>
<dl class="method">
<dt id="pyhamtools.callinfo.Callinfo.is_valid_callsign">
<tt class="descname">is_valid_callsign</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>27244</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.is_valid_callsign" title="Permalink to this definition"></a></dt>
<tt class="descname">is_valid_callsign</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>397379</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.callinfo.Callinfo.is_valid_callsign" title="Permalink to this definition"></a></dt>
<dd><p>Checks if a callsign is valid</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -417,8 +417,8 @@ dedicated entry in the database exists.</p>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="utils.html"
title="previous chapter">utils</a></p>
<p class="topless"><a href="locator.html"
title="previous chapter">locator</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="LookupLib.html"
title="next chapter">LookupLib</a></p>
@ -457,14 +457,14 @@ dedicated entry in the database exists.</p>
<a href="LookupLib.html" title="LookupLib"
>next</a> |</li>
<li class="right" >
<a href="utils.html" title="utils"
<a href="locator.html" title="locator"
>previous</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Tobias Wellnitz, DH1TW.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>

4
docs/build/html/_sources/index.txt vendored
View file

@ -12,7 +12,8 @@
:IRC: #hamtests on webirc.deltaxray.org
PyHamTools is a Python library which helps you creating Amateur Radio applications faster. It comes
with some modules and classes which are frequently necessary, like parsing of an Amateur Radio callsign.
with some modules and classes which are frequently needed, like locator based calculations (distance,
heading, etc) or parsing of an Amateur Radio callsign.
Currently, PyHamtools contain the following modules and classes:
@ -22,6 +23,7 @@ Modules
:maxdepth: 2
utils
locator
Clases
^^^^^^

52
docs/build/html/genindex.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; pyhamtools 0.3.1 documentation</title>
<title>Index &mdash; pyhamtools 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
VERSION: '0.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyhamtools 0.3.1 documentation" href="index.html" />
<link rel="top" title="pyhamtools 0.4.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -36,7 +36,7 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -61,12 +61,32 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="Callinfo.html#pyhamtools.callinfo.Callinfo">Callinfo (class in pyhamtools.callinfo)</a>
<dt><a href="locator.html#pyhamtools.locator.calculate_distance">calculate_distance() (in module pyhamtools.locator)</a>
</dt>
<dt><a href="locator.html#pyhamtools.locator.calculate_distance_longpath">calculate_distance_longpath() (in module pyhamtools.locator)</a>
</dt>
<dt><a href="locator.html#pyhamtools.locator.calculate_heading">calculate_heading() (in module pyhamtools.locator)</a>
</dt>
<dt><a href="locator.html#pyhamtools.locator.calculate_heading_longpath">calculate_heading_longpath() (in module pyhamtools.locator)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="locator.html#pyhamtools.locator.calculate_sunrise_sunset">calculate_sunrise_sunset() (in module pyhamtools.locator)</a>
</dt>
<dt><a href="Callinfo.html#pyhamtools.callinfo.Callinfo">Callinfo (class in pyhamtools.callinfo)</a>
</dt>
<dt><a href="LookupLib.html#pyhamtools.lookuplib.LookupLib.copy_data_in_redis">copy_data_in_redis() (pyhamtools.lookuplib.LookupLib method)</a>
</dt>
@ -143,6 +163,14 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="locator.html#pyhamtools.locator.latlong_to_locator">latlong_to_locator() (in module pyhamtools.locator)</a>
</dt>
<dt><a href="locator.html#pyhamtools.locator.locator_to_latlong">locator_to_latlong() (in module pyhamtools.locator)</a>
</dt>
<dt><a href="LookupLib.html#pyhamtools.lookuplib.LookupLib.lookup_callsign">lookup_callsign() (pyhamtools.lookuplib.LookupLib method)</a>
</dt>
@ -150,12 +178,12 @@
<dt><a href="LookupLib.html#pyhamtools.lookuplib.LookupLib.lookup_entity">lookup_entity() (pyhamtools.lookuplib.LookupLib method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="LookupLib.html#pyhamtools.lookuplib.LookupLib.lookup_prefix">lookup_prefix() (pyhamtools.lookuplib.LookupLib method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="LookupLib.html#pyhamtools.lookuplib.LookupLib.lookup_zone_exception">lookup_zone_exception() (pyhamtools.lookuplib.LookupLib method)</a>
</dt>
@ -175,12 +203,16 @@
</dt>
<dt><a href="LookupLib.html#module-pyhamtools.lookuplib">pyhamtools.lookuplib (module)</a>
<dt><a href="locator.html#module-pyhamtools.locator">pyhamtools.locator (module)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="LookupLib.html#module-pyhamtools.lookuplib">pyhamtools.lookuplib (module)</a>
</dt>
<dt><a href="utils.html#module-pyhamtools.utils">pyhamtools.utils (module)</a>
</dt>
@ -223,12 +255,12 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Tobias Wellnitz, DH1TW.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>

12
docs/build/html/help.html vendored
View file

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>help &mdash; pyhamtools 0.3.1 documentation</title>
<title>help &mdash; pyhamtools 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
VERSION: '0.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyhamtools 0.3.1 documentation" href="index.html" />
<link rel="top" title="pyhamtools 0.4.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -35,7 +35,7 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -86,12 +86,12 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Tobias Wellnitz, DH1TW.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>

20
docs/build/html/index.html vendored
View file

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>PyHamTools &mdash; pyhamtools 0.3.1 documentation</title>
<title>PyHamTools &mdash; pyhamtools 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
VERSION: '0.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyhamtools 0.3.1 documentation" href="#" />
<link rel="top" title="pyhamtools 0.4.0 documentation" href="#" />
<link rel="next" title="utils" href="utils.html" />
</head>
<body>
@ -39,7 +39,7 @@
<li class="right" >
<a href="utils.html" title="utils"
accesskey="N">next</a> |</li>
<li><a href="#">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="#">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -54,7 +54,7 @@
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Version:</th><td class="field-body">0.3.1</td>
<tr class="field-odd field"><th class="field-name">Version:</th><td class="field-body">0.4.0</td>
</tr>
<tr class="field-even field"><th class="field-name">Code:</th><td class="field-body"><a class="reference external" href="https://github.com/dh1tw/pyhamtools">https://github.com/dh1tw/pyhamtools</a></td>
</tr>
@ -69,7 +69,8 @@
</tbody>
</table>
<p>PyHamTools is a Python library which helps you creating Amateur Radio applications faster. It comes
with some modules and classes which are frequently necessary, like parsing of an Amateur Radio callsign.</p>
with some modules and classes which are frequently needed, like locator based calculations (distance,
heading, etc) or parsing of an Amateur Radio callsign.</p>
<p>Currently, PyHamtools contain the following modules and classes:</p>
<div class="section" id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Permalink to this headline"></a></h2>
@ -78,6 +79,9 @@ with some modules and classes which are frequently necessary, like parsing of an
<li class="toctree-l1"><a class="reference internal" href="utils.html">utils</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="locator.html">locator</a><ul class="simple">
</ul>
</li>
</ul>
</div>
</div>
@ -159,12 +163,12 @@ with some modules and classes which are frequently necessary, like parsing of an
<li class="right" >
<a href="utils.html" title="utils"
>next</a> |</li>
<li><a href="#">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="#">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Tobias Wellnitz, DH1TW.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>

12
docs/build/html/license.html vendored
View file

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>license &mdash; pyhamtools 0.3.1 documentation</title>
<title>license &mdash; pyhamtools 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
VERSION: '0.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyhamtools 0.3.1 documentation" href="index.html" />
<link rel="top" title="pyhamtools 0.4.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -35,7 +35,7 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -112,12 +112,12 @@ SOFTWARE.</p>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Tobias Wellnitz, DH1TW.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>

20
docs/build/html/lookuplib.html vendored
View file

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>LookupLib &mdash; pyhamtools 0.3.1 documentation</title>
<title>LookupLib &mdash; pyhamtools 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
VERSION: '0.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyhamtools 0.3.1 documentation" href="index.html" />
<link rel="top" title="pyhamtools 0.4.0 documentation" href="index.html" />
<link rel="prev" title="Callinfo" href="Callinfo.html" />
</head>
<body>
@ -39,7 +39,7 @@
<li class="right" >
<a href="Callinfo.html" title="Callinfo"
accesskey="P">previous</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -152,7 +152,7 @@ instance of Redis, as well the python Redis connector (pip install redis-py).</p
<dl class="method">
<dt id="pyhamtools.lookuplib.LookupLib.is_invalid_operation">
<tt class="descname">is_invalid_operation</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>30</em>, <em>46</em>, <em>719586</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.is_invalid_operation" title="Permalink to this definition"></a></dt>
<tt class="descname">is_invalid_operation</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>393560</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.is_invalid_operation" title="Permalink to this definition"></a></dt>
<dd><p>Returns True if an operations is known as invalid</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -208,7 +208,7 @@ API Key for Clublog missing or incorrect</li>
<dl class="method">
<dt id="pyhamtools.lookuplib.LookupLib.lookup_callsign">
<tt class="descname">lookup_callsign</tt><big>(</big><em>callsign=None</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>30</em>, <em>46</em>, <em>719553</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_callsign" title="Permalink to this definition"></a></dt>
<tt class="descname">lookup_callsign</tt><big>(</big><em>callsign=None</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>393534</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_callsign" title="Permalink to this definition"></a></dt>
<dd><p>Returns lookup data if an exception exists for a callsign</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -314,7 +314,7 @@ the id 273.</p>
<dl class="method">
<dt id="pyhamtools.lookuplib.LookupLib.lookup_prefix">
<tt class="descname">lookup_prefix</tt><big>(</big><em>prefix</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>30</em>, <em>46</em>, <em>719553</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_prefix" title="Permalink to this definition"></a></dt>
<tt class="descname">lookup_prefix</tt><big>(</big><em>prefix</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>393534</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_prefix" title="Permalink to this definition"></a></dt>
<dd><p>Returns lookup data of a Prefix</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@ -372,7 +372,7 @@ database (default database).</p>
<dl class="method">
<dt id="pyhamtools.lookuplib.LookupLib.lookup_zone_exception">
<tt class="descname">lookup_zone_exception</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>30</em>, <em>46</em>, <em>719594</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_zone_exception" title="Permalink to this definition"></a></dt>
<tt class="descname">lookup_zone_exception</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>9</em>, <em>21</em>, <em>18</em>, <em>15</em>, <em>2</em>, <em>393566</em>, <em>tzinfo=&lt;UTC&gt;)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_zone_exception" title="Permalink to this definition"></a></dt>
<dd><p>Returns a CQ Zone if an exception exists for the given callsign</p>
<p>Args:
callsign (string): Amateur radio callsign
@ -464,12 +464,12 @@ in CQ Zone 38</p>
<li class="right" >
<a href="Callinfo.html" title="Callinfo"
>previous</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Tobias Wellnitz, DH1TW.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>

BIN
docs/build/html/objects.inv vendored
View file

Binary file not shown.

17
docs/build/html/py-modindex.html vendored
View file

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Python Module Index &mdash; pyhamtools 0.3.1 documentation</title>
<title>Python Module Index &mdash; pyhamtools 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
VERSION: '0.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyhamtools 0.3.1 documentation" href="index.html" />
<link rel="top" title="pyhamtools 0.4.0 documentation" href="index.html" />
@ -38,7 +38,7 @@
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -69,6 +69,11 @@
<td>&nbsp;&nbsp;&nbsp;
<a href="Callinfo.html#module-pyhamtools.callinfo"><tt class="xref">pyhamtools.callinfo</tt></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="locator.html#module-pyhamtools.locator"><tt class="xref">pyhamtools.locator</tt></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
@ -113,12 +118,12 @@
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Tobias Wellnitz, DH1TW.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>

12
docs/build/html/search.html vendored
View file

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; pyhamtools 0.3.1 documentation</title>
<title>Search &mdash; pyhamtools 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
VERSION: '0.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="pyhamtools 0.3.1 documentation" href="index.html" />
<link rel="top" title="pyhamtools 0.4.0 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
@ -43,7 +43,7 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -94,12 +94,12 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">pyhamtools 0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html">pyhamtools 0.4.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Tobias Wellnitz, DH1TW.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>

2
docs/build/html/searchindex.js vendored
View file

File diff suppressed because one or more lines are too long

2
docs/source/conf.py
View file

@ -248,7 +248,7 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
('index', 'pyhamtools', u'pyhamtools Documentation',
u'Tobias Wellnitz, DH1TW', 'pyhamtools', 'One line description of project.',
u'Tobias Wellnitz, DH1TW', 'pyhamtools', 'Toolkit for ham radio software developers',
'Miscellaneous'),
]