reviewed headline issues

AUTHORS.md

@@ -1,7 +1,5 @@
 > ⚠ This document _only_ reflects the responsible developers at HEXONET GmbH. For a list of MUCH-APPRECIATED CONTRIBUTORS -- people who helped developing and extending this library, applying patches, adding helpful comments
 and thus generally made it that much better, see [GitHub's list of contributors](https://github.com/hexonet/python-sdk/contributors).
 
-# HEXONET Developers
-
 * [Anthony Schneider](//github.com/isharky) - Original Implementation
 * [Kai Schwarz](//github.com/papakai) - Full Review

docs/_build/html/_sources/changelog.rst.txt

@@ -1,4 +1,3 @@
-Changelog
-=========
+.. _changelog:
 
 .. mdinclude:: ../HISTORY.md

docs/_build/html/_sources/config.rst.txt

@@ -46,24 +46,31 @@ or by using the :class:`hexonet.apiconnector.connection.Connection` class accord
 Environment and Debug Features
 ------------------------------
 
-HEXONET provides two different Backend Systems that you might consider to use:
+Debug Features, are up to now not available in our Python SDK, but planned.
 
-- Operational Test & Evaluation (OT&E) System (set 'entity' to '1234')
+HEXONET provides two different Backend Systems that you might consider to use.
+Both require a separate registration_ first.
+
+.. _registration: https://www.hexonet.net
+
+
+
+OT&E System
+^^^^^^^^^^^
+
+OT&E Sytem stands for Operational Test & Evaluation System.
 No costs, just for playing around with things. This system can be seen as a
 kind of sandbox system that allows to test your integration first before going
 live with it. This system and the use of our products and services is completely
 free of charge.
+To use this system, set configuration value for property `entity` to `1234`.
+
+LIVE System
+^^^^^^^^^^^
 
-- LIVE System (set 'entity' to '54cd')
 The real world system - This system and the use our services and products can lead
 to real costs depending on what you're exactly doing.
-
-Both systems need a separate registration_ first.
-
-.. _registration: https://www.hexonet.net
-
-Debug Features, are up to now not available at the hexonet.apiconnector, but planned.
-
+To use this system, set configuration value for property `entity` to `54cd`.
 
 Builtin Configuration Values
 ----------------------------

docs/_build/html/_sources/contributing.rst.txt

@@ -1,6 +1,3 @@
 .. _contributing:
 
-Contributing
-============
-
 .. mdinclude:: ../CONTRIBUTING.md

docs/_build/html/api.html

@@ -81,9 +81,7 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
-<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="contributing.html#id2">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact Us</a></li>
 </ul>
 

docs/_build/html/api/hexonet.apiconnector.html

@@ -82,9 +82,7 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading to Newer Releases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../license.html#hexonet-developers">HEXONET Developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing.html#id2">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact Us</a></li>
 </ul>
 

docs/_build/html/changelog.html

@@ -77,13 +77,18 @@ <h2>Table Of Contents</h2>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#id1">Changelog</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id3">1.2.5</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id5">1.2.4</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id7">1.2.3</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id9">1.2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id11">1.2.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id13">1.2.0</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id15">1.1.0</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id16">1.0.0</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
-<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="contributing.html#id2">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact Us</a></li>
 </ul>
 
@@ -96,7 +101,6 @@ <h2>Contents</h2>
     <div class="sidebar-localtoc">
       <ul>
 <li><a class="reference internal" href="#">Changelog</a><ul>
-<li><a class="reference internal" href="#id1">Changelog</a><ul>
 <li><a class="reference internal" href="#id3">1.2.5</a></li>
 <li><a class="reference internal" href="#id5">1.2.4</a></li>
 <li><a class="reference internal" href="#id7">1.2.3</a></li>
@@ -107,8 +111,6 @@ <h2>Contents</h2>
 <li><a class="reference internal" href="#id16">1.0.0</a></li>
 </ul>
 </li>
-</ul>
-</li>
 </ul>
 
     </div>
@@ -143,13 +145,11 @@ <h2>Contents</h2>
           <div class="document clearer body">
 
   <div class="section" id="changelog">
-<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="id1">
-<h2>Changelog<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<span id="id1"></span><h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
 <p>All notable changes to this project will be documented in this file. Dates are displayed in UTC.</p>
 <p>Generated by <cite>``auto-changelog`</cite> &lt;<a class="reference external" href="https://github.com/CookPete/auto-changelog">https://github.com/CookPete/auto-changelog</a>&gt;`_.</p>
 <div class="section" id="id3">
-<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.4...1.2.5">1.2.5</a><a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
+<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.4...1.2.5">1.2.5</a><a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div>9 July 2018</div></blockquote>
 <ul class="simple">
@@ -158,7 +158,7 @@ <h3><a class="reference external" href="https://github.com/hexonet/python-sdk/co
 </ul>
 </div>
 <div class="section" id="id5">
-<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.3...1.2.4">1.2.4</a><a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
+<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.3...1.2.4">1.2.4</a><a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div>9 July 2018</div></blockquote>
 <ul class="simple">
@@ -168,7 +168,7 @@ <h3><a class="reference external" href="https://github.com/hexonet/python-sdk/co
 </ul>
 </div>
 <div class="section" id="id7">
-<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.2...1.2.3">1.2.3</a><a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
+<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.2...1.2.3">1.2.3</a><a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div>9 July 2018</div></blockquote>
 <ul class="simple">
@@ -177,15 +177,15 @@ <h3><a class="reference external" href="https://github.com/hexonet/python-sdk/co
 </ul>
 </div>
 <div class="section" id="id9">
-<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.1...1.2.2">1.2.2</a><a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
+<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.1...1.2.2">1.2.2</a><a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div>9 July 2018</div></blockquote>
 <ul class="simple">
 <li>try import renaming <cite>``d3fa6ae`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6">https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6</a>&gt;`_</li>
 </ul>
 </div>
 <div class="section" id="id11">
-<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.0...1.2.1">1.2.1</a><a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
+<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.0...1.2.1">1.2.1</a><a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div>9 July 2018</div></blockquote>
 <ul class="simple">
@@ -195,7 +195,7 @@ <h3><a class="reference external" href="https://github.com/hexonet/python-sdk/co
 </ul>
 </div>
 <div class="section" id="id13">
-<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.1.0...1.2.0">1.2.0</a><a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
+<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.1.0...1.2.0">1.2.0</a><a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div>9 July 2018</div></blockquote>
 <ul class="simple">
@@ -205,7 +205,7 @@ <h3><a class="reference external" href="https://github.com/hexonet/python-sdk/co
 </ul>
 </div>
 <div class="section" id="id15">
-<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.0.0...1.1.0">1.1.0</a><a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
+<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.0.0...1.1.0">1.1.0</a><a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div>9 July 2018</div></blockquote>
 <ul class="simple">
@@ -216,7 +216,7 @@ <h3><a class="reference external" href="https://github.com/hexonet/python-sdk/co
 </ul>
 </div>
 <div class="section" id="id16">
-<h3>1.0.0<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
+<h2>1.0.0<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div>9 July 2018</div></blockquote>
 <ul class="simple">
@@ -231,7 +231,6 @@ <h3>1.0.0<a class="headerlink" href="#id16" title="Permalink to this headline">
 <li>Initial commit <cite>``c89c917`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/c89c917845cda5cef9e4f3a4fb5dc9d022e48006">https://github.com/hexonet/python-sdk/commit/c89c917845cda5cef9e4f3a4fb5dc9d022e48006</a>&gt;`_</li>
 </ul>
 </div>
-</div>
 </div>
 
 

docs/_build/html/config.html

@@ -83,9 +83,7 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
-<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="contributing.html#id2">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact Us</a></li>
 </ul>
 
@@ -99,7 +97,11 @@ <h2>Contents</h2>
       <ul>
 <li><a class="reference internal" href="#">Configuration Handling</a><ul>
 <li><a class="reference internal" href="#configuration-basics">Configuration Basics</a></li>
-<li><a class="reference internal" href="#environment-and-debug-features">Environment and Debug Features</a></li>
+<li><a class="reference internal" href="#environment-and-debug-features">Environment and Debug Features</a><ul>
+<li><a class="reference internal" href="#ot-e-system">OT&amp;E System</a></li>
+<li><a class="reference internal" href="#live-system">LIVE System</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#builtin-configuration-values">Builtin Configuration Values</a></li>
 </ul>
 </li>
@@ -176,21 +178,24 @@ <h2>Configuration Basics<a class="headerlink" href="#configuration-basics" title
 </div>
 <div class="section" id="environment-and-debug-features">
 <h2>Environment and Debug Features<a class="headerlink" href="#environment-and-debug-features" title="Permalink to this headline">¶</a></h2>
-<p>HEXONET provides two different Backend Systems that you might consider to use:</p>
-<ul class="simple">
-<li>Operational Test &amp; Evaluation (OT&amp;E) System (set ‘entity’ to ‘1234’)</li>
-</ul>
-<p>No costs, just for playing around with things. This system can be seen as a
+<p>Debug Features, are up to now not available in our Python SDK, but planned.</p>
+<p>HEXONET provides two different Backend Systems that you might consider to use.
+Both require a separate <a class="reference external" href="https://www.hexonet.net">registration</a> first.</p>
+<div class="section" id="ot-e-system">
+<h3>OT&amp;E System<a class="headerlink" href="#ot-e-system" title="Permalink to this headline">¶</a></h3>
+<p>OT&amp;E Sytem stands for Operational Test &amp; Evaluation System.
+No costs, just for playing around with things. This system can be seen as a
 kind of sandbox system that allows to test your integration first before going
 live with it. This system and the use of our products and services is completely
-free of charge.</p>
-<ul class="simple">
-<li>LIVE System (set ‘entity’ to ‘54cd’)</li>
-</ul>
+free of charge.
+To use this system, set configuration value for property <cite>entity</cite> to <cite>1234</cite>.</p>
+</div>
+<div class="section" id="live-system">
+<h3>LIVE System<a class="headerlink" href="#live-system" title="Permalink to this headline">¶</a></h3>
 <p>The real world system - This system and the use our services and products can lead
-to real costs depending on what you’re exactly doing.</p>
-<p>Both systems need a separate <a class="reference external" href="https://www.hexonet.net">registration</a> first.</p>
-<p>Debug Features, are up to now not available at the hexonet.apiconnector, but planned.</p>
+to real costs depending on what you’re exactly doing.
+To use this system, set configuration value for property <cite>entity</cite> to <cite>54cd</cite>.</p>
+</div>
 </div>
 <div class="section" id="builtin-configuration-values">
 <h2>Builtin Configuration Values<a class="headerlink" href="#builtin-configuration-values" title="Permalink to this headline">¶</a></h2>

docs/_build/html/contactus.html

@@ -74,9 +74,7 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
-<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="contributing.html#id2">Contributing</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Contact Us</a></li>
 </ul>
 

docs/_build/html/contributing.html

@@ -78,9 +78,7 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
-<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="#id2">Contributing</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#pull-request-pr-process">Pull Request (PR) Process</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#code-of-conduct">Code of Conduct</a></li>
 </ul>
@@ -96,8 +94,7 @@ <h2>Table Of Contents</h2>
     <h2>Contents</h2>
     <div class="sidebar-localtoc">
       <ul>
-<li><a class="reference internal" href="#">Contributing</a></li>
-<li><a class="reference internal" href="#id2">Contributing</a><ul>
+<li><a class="reference internal" href="#">Contributing</a><ul>
 <li><a class="reference internal" href="#pull-request-pr-process">Pull Request (PR) Process</a></li>
 <li><a class="reference internal" href="#code-of-conduct">Code of Conduct</a><ul>
 <li><a class="reference internal" href="#our-pledge">Our Pledge</a></li>
@@ -145,9 +142,6 @@ <h2>Contents</h2>
 
   <div class="section" id="contributing">
 <span id="id1"></span><h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
-</div>
-<div class="section" id="id2">
-<h1>Contributing<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h1>
 <p>When contributing to this repository, please first discuss the change you wish to make via issue,
 email, or any other method with the owners of this repository before making a change.</p>
 <p>Please note we have a code of conduct, please follow it in all your interactions with the project.</p>

docs/_build/html/debugging.html

@@ -78,9 +78,7 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
-<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="contributing.html#id2">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact Us</a></li>
 </ul>
 

docs/_build/html/foreword.html

@@ -82,9 +82,7 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
-<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
-<li class="toctree-l1"><a class="reference internal" href="contributing.html#id2">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact Us</a></li>
 </ul>