use of m2r and mdincludes - WOW

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

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

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

@@ -3,4 +3,4 @@
 Contributing
 ============
 
-.. include:: ../CONTRIBUTING.md
+.. mdinclude:: ../CONTRIBUTING.md

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

@@ -13,7 +13,7 @@ The full license text can be found below (:ref:`mit-license`).
 Authors
 -------
 
-.. include:: ../AUTHORS.md
+.. mdinclude:: ../AUTHORS.md
 
 General License Definitions
 ---------------------------

docs/_build/html/api.html

@@ -81,7 +81,9 @@ <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,7 +82,9 @@ <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/config.html

@@ -83,7 +83,9 @@ <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/contactus.html

@@ -74,7 +74,9 @@ <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,13 +78,43 @@ <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-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>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact Us</a></li>
 </ul>
 
 
   </div>
 </div>
+<div class="sidebar-block">
+  <div class="sidebar-wrapper">
+    <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="#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>
+<li><a class="reference internal" href="#our-standards">Our Standards</a></li>
+<li><a class="reference internal" href="#our-responsibilities">Our Responsibilities</a></li>
+<li><a class="reference internal" href="#scope">Scope</a></li>
+<li><a class="reference internal" href="#enforcement">Enforcement</a></li>
+<li><a class="reference internal" href="#attribution">Attribution</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+    </div>
+  </div>
+</div>
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <div id="main-search">
@@ -115,25 +145,33 @@ <h2>Table Of 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>
-<p># Contributing</p>
+</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>
-<p>## Pull Request (PR) Process</p>
+<div class="section" id="pull-request-pr-process">
+<h2>Pull Request (PR) Process<a class="headerlink" href="#pull-request-pr-process" title="Permalink to this headline">¶</a></h2>
 <ol class="arabic simple">
 <li>Ensure any install or build dependencies are removed before the end of the layer when doing a build.</li>
 <li>Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.</li>
 <li>Address the PR to us, we care about further steps like versioning etc.</li>
 </ol>
-<p>## Code of Conduct</p>
-<p>### Our Pledge</p>
+</div>
+<div class="section" id="code-of-conduct">
+<h2>Code of Conduct<a class="headerlink" href="#code-of-conduct" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="our-pledge">
+<h3>Our Pledge<a class="headerlink" href="#our-pledge" title="Permalink to this headline">¶</a></h3>
 <p>In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, gender identity and expression, level of experience,
 nationality, personal appearance, race, religion, or sexual identity and
 orientation.</p>
-<p>### Our Standards</p>
+</div>
+<div class="section" id="our-standards">
+<h3>Our Standards<a class="headerlink" href="#our-standards" title="Permalink to this headline">¶</a></h3>
 <p>Examples of behavior that contributes to creating a positive environment
 include:</p>
 <ul class="simple">
@@ -153,7 +191,9 @@ <h2>Table Of Contents</h2>
 <li>Other conduct which could reasonably be considered inappropriate in a
 professional setting</li>
 </ul>
-<p>### Our Responsibilities</p>
+</div>
+<div class="section" id="our-responsibilities">
+<h3>Our Responsibilities<a class="headerlink" href="#our-responsibilities" title="Permalink to this headline">¶</a></h3>
 <p>Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behavior.</p>
@@ -162,14 +202,18 @@ <h2>Table Of Contents</h2>
 that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.</p>
-<p>### Scope</p>
+</div>
+<div class="section" id="scope">
+<h3>Scope<a class="headerlink" href="#scope" title="Permalink to this headline">¶</a></h3>
 <p>This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. Examples of
 representing a project or community include using an official project e-mail
 address, posting via an official social media account, or acting as an appointed
 representative at an online or offline event. Representation of a project may be
 further defined and clarified by project maintainers.</p>
-<p>### Enforcement</p>
+</div>
+<div class="section" id="enforcement">
+<h3>Enforcement<a class="headerlink" href="#enforcement" title="Permalink to this headline">¶</a></h3>
 <p>Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
 complaints will be reviewed and investigated and will result in a response that
@@ -179,11 +223,13 @@ <h2>Table Of Contents</h2>
 <p>Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project’s leadership.</p>
-<p>### Attribution</p>
-<p>This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [<a class="reference external" href="http://contributor-covenant.org/version/1/4][version">http://contributor-covenant.org/version/1/4][version</a>]</p>
-<p>[homepage]: <a class="reference external" href="http://contributor-covenant.org">http://contributor-covenant.org</a>
-[version]: <a class="reference external" href="http://contributor-covenant.org/version/1/4/">http://contributor-covenant.org/version/1/4/</a></p>
+</div>
+<div class="section" id="attribution">
+<h3>Attribution<a class="headerlink" href="#attribution" title="Permalink to this headline">¶</a></h3>
+<p>This Code of Conduct is adapted from the <a class="reference external" href="http://contributor-covenant.org">Contributor Covenant</a>, version 1.4,
+available at <a class="reference external" href="http://contributor-covenant.org/version/1/4/">http://contributor-covenant.org/version/1/4</a></p>
+</div>
+</div>
 </div>
 
 

docs/_build/html/debugging.html

@@ -78,7 +78,9 @@ <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,7 +82,9 @@ <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/genindex.html

@@ -71,7 +71,9 @@ <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/index.html

@@ -74,7 +74,9 @@ <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>
 
@@ -187,14 +189,25 @@ <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permal
 <div class="toctree-wrapper compound">
 <ul>
 <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="changelog.html">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">Changelog</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="license.html#authors">Authors</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="license.html#general-license-definitions">General License Definitions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="license.html#mit-license">MIT License</a></li>
 </ul>
 </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><ul>
+<li class="toctree-l2"><a class="reference internal" href="contributing.html#pull-request-pr-process">Pull Request (PR) Process</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contributing.html#code-of-conduct">Code of Conduct</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact Us</a></li>
 </ul>
 </div>

docs/_build/html/installation.html

@@ -83,7 +83,9 @@ <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/license.html

@@ -79,11 +79,15 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">License</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#authors">Authors</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="#hexonet-developers">HEXONET Developers</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#general-license-definitions">General License Definitions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#mit-license">MIT License</a></li>
 </ul>
 </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>
 
@@ -97,6 +101,9 @@ <h2>Contents</h2>
       <ul>
 <li><a class="reference internal" href="#">License</a><ul>
 <li><a class="reference internal" href="#authors">Authors</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#hexonet-developers">HEXONET Developers</a><ul>
 <li><a class="reference internal" href="#general-license-definitions">General License Definitions</a></li>
 <li><a class="reference internal" href="#mit-license">MIT License</a></li>
 </ul>
@@ -143,14 +150,17 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headli
 <p>The full license text can be found below (<a class="reference internal" href="#mit-license"><span class="std std-ref">MIT License</span></a>).</p>
 <div class="section" id="authors">
 <span id="id1"></span><h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
-<p>&gt; ⚠ 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](<a class="reference external" href="https://github.com/hexonet/python-sdk/contributors">https://github.com/hexonet/python-sdk/contributors</a>).</p>
-<p># HEXONET Developers</p>
+<blockquote>
+<div>⚠ This document <em>only</em> 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 <a class="reference external" href="https://github.com/hexonet/python-sdk/contributors">GitHub’s list of contributors</a>.</div></blockquote>
+</div>
+</div>
+<div class="section" id="hexonet-developers">
+<h1>HEXONET Developers<a class="headerlink" href="#hexonet-developers" title="Permalink to this headline">¶</a></h1>
 <ul class="simple">
-<li>[Anthony Schneider](//github.com/isharky) - Original Implementation</li>
-<li>[Kai Schwarz](//github.com/papakai) - Full Review</li>
+<li><a class="reference external" href="//github.com/isharky">Anthony Schneider</a> - Original Implementation</li>
+<li><a class="reference external" href="//github.com/papakai">Kai Schwarz</a> - Full Review</li>
 </ul>
-</div>
 <div class="section" id="general-license-definitions">
 <h2>General License Definitions<a class="headerlink" href="#general-license-definitions" title="Permalink to this headline">¶</a></h2>
 <p>The following section contains the full license texts for this module and the