update docs

README.md

@@ -78,8 +78,9 @@ This is not a release version and can not be considered to be stable!
 [https://github.com/oliver-zehentleitner/unicorn_fy/wiki](https://github.com/oliver-zehentleitner/unicorn_fy/wiki)
 
 ## Receive Notifications
-To receive notifications on available updates you can ![watch](https://s3.gifyu.com/images/github_watch.png) the 
-repository on [GitHub](https://github.com/oliver-zehentleitner/unicorn_fy), write your 
+To receive notifications on available updates you can 
+[![watch](https://s3.gifyu.com/images/github_watch.png)](https://github.com/oliver-zehentleitner/unicorn_fy/watchers) 
+the repository on [GitHub](https://github.com/oliver-zehentleitner/unicorn_fy), write your 
 [own script](https://github.com/oliver-zehentleitner/unicorn_fy/blob/master/example_version_of_this_package.py) 
 with using `unicorn_fy.is_update_availabe()` or you use the 
 [monitoring API service](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/wiki/UNICORN-Monitoring-API-Service).

docs/.buildinfo

@@ -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: 5d60098e2d2aa751399d30d063497b07
+config: 028a85fbb66bf24ff2759cbf553f085f
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/README.html

@@ -64,13 +64,11 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <p><img alt="GitHub release" src="https://img.shields.io/github/release/oliver-zehentleitner/unicorn_fy.svg" />
-<img alt="GitHub" src="https://img.shields.io/github/license/oliver-zehentleitner/unicorn_fy.svg?color=blue" />
-<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/unicorn_fy.svg" />
-<img alt="PyPI - Status" src="https://img.shields.io/pypi/status/unicorn_fy.svg" />
-<img alt="PyPI - yes" src="https://img.shields.io/badge/PyPI-yes-brightgreen.svg?color=orange" />
-<img alt="PyPI - Wheel" src="https://img.shields.io/pypi/wheel/unicorn_fy.svg?label=PyPI%20wheel&amp;color=orange" />
-<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/unicorn-fy.svg?label=PyPI%20downloads&amp;color=orange" /></p>
+  <p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy/releases/latest"><img alt="https://img.shields.io/github/release/oliver-zehentleitner/unicorn_fy.svg" src="https://img.shields.io/github/release/oliver-zehentleitner/unicorn_fy.svg" />GitHub release</a>
+<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy/blob/master/LICENSE"><img alt="https://img.shields.io/github/license/oliver-zehentleitner/unicorn_fy.svg?color=blue" src="https://img.shields.io/github/license/oliver-zehentleitner/unicorn_fy.svg?color=blue" />GitHub</a>
+<a class="reference external" href="https://www.python.org/downloads/"><img alt="https://img.shields.io/pypi/pyversions/unicorn_fy.svg" src="https://img.shields.io/pypi/pyversions/unicorn_fy.svg" />PyPI - Python Version</a>
+<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy/issues"><img alt="https://img.shields.io/pypi/status/unicorn_fy.svg" src="https://img.shields.io/pypi/status/unicorn_fy.svg" />PyPI - Status</a>
+<a class="reference external" href="https://pypi.org/project/unicorn-fy/"><img alt="https://img.shields.io/pypi/wheel/unicorn_fy.svg?label=PyPI%20wheel&amp;color=orange" src="https://img.shields.io/pypi/wheel/unicorn_fy.svg?label=PyPI%20wheel&amp;color=orange" />PyPI - Wheel</a></p>
 <div class="section" id="unicornfy">
 <h1>UnicornFy<a class="headerlink" href="#unicornfy" title="Permalink to this headline">¶</a></h1>
 <p>Convert received raw data from crypto exchange API endpoints into well-formed python dictionaries.</p>
@@ -99,7 +97,7 @@ <h1>UnicornFy<a class="headerlink" href="#unicornfy" title="Permalink to this he
 </pre></div>
 </div>
 <p>Currently this module has no dependencies.</p>
-<p>If you like the project, please <img alt="star" src="https://s3.gifyu.com/images/stard237b3003af9f9a9.png" /> it on
+<p>If you like the project, please <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy/stargazers"><img alt="https://s3.gifyu.com/images/stard237b3003af9f9a9.png" src="https://s3.gifyu.com/images/stard237b3003af9f9a9.png" />star</a> it on
 <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy">GitHub</a>!</p>
 <div class="section" id="supported-exchanges">
 <h2>Supported Exchanges<a class="headerlink" href="#supported-exchanges" title="Permalink to this headline">¶</a></h2>
@@ -146,7 +144,10 @@ <h3>From the latest source (dev-stage) with PIP from <a class="reference externa
 </div>
 <div class="section" id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
-<p><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn_fy/">https://oliver-zehentleitner.github.io/unicorn_fy/</a></p>
+<ul class="simple">
+<li><p><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn_fy">General</a></p></li>
+<li><p><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn_fy/unicorn_fy.html">Modules</a></p></li>
+</ul>
 </div>
 <div class="section" id="source-downloads-examples">
 <h2>Source, Downloads, Examples, …<a class="headerlink" href="#source-downloads-examples" title="Permalink to this headline">¶</a></h2>
@@ -162,16 +163,17 @@ <h2>Wiki<a class="headerlink" href="#wiki" title="Permalink to this headline">¶
 </div>
 <div class="section" id="receive-notifications">
 <h2>Receive Notifications<a class="headerlink" href="#receive-notifications" title="Permalink to this headline">¶</a></h2>
-<p>To receive notifications on available updates you can <img alt="watch" src="https://s3.gifyu.com/images/github_watch.png" /> the
-repository on <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy">GitHub</a>, write your
+<p>To receive notifications on available updates you can
+<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy/watchers"><img alt="https://s3.gifyu.com/images/github_watch.png" src="https://s3.gifyu.com/images/github_watch.png" />watch</a>
+the repository on <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy">GitHub</a>, write your
 <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy/blob/master/example_version_of_this_package.py">own script</a>
 with using <code class="docutils literal notranslate"><span class="pre">unicorn_fy.is_update_availabe()</span></code> or you use the
 <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/wiki/UNICORN-Monitoring-API-Service">monitoring API service</a>.</p>
 </div>
 <div class="section" id="how-to-report-bugs-or-suggest-improvements">
 <h2>How to report Bugs or suggest Improvements?<a class="headerlink" href="#how-to-report-bugs-or-suggest-improvements" title="Permalink to this headline">¶</a></h2>
 <p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement">List of planned features</a> -
-click <img alt="thumbs-up" src="https://s3.gifyu.com/images/tu.png" /> if you need one of them or suggest a new feature!</p>
+click <img alt="https://s3.gifyu.com/images/tu.png" src="https://s3.gifyu.com/images/tu.png" />thumbs-up if you need one of them or suggest a new feature!</p>
 <p>Before you report a bug, <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy#installation-and-upgrade">try the latest release</a>.
 If the issue still exists, provide the error trace, OS and python version and explain how to reproduce the error.
 A demo script is appreciated.</p>
@@ -185,7 +187,7 @@ <h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to t
 source project which welcomes contributions which can be anything from simple documentation fixes to new features. To
 contribute follow
 <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn_fy/blob/master/CONTRIBUTING">this guide</a>.</p>
-<p>We <img alt="love" src="https://s3.gifyu.com/images/heartae002231c41d8a80.png" /> open source!</p>
+<p>We <img alt="https://s3.gifyu.com/images/heartae002231c41d8a80.png" src="https://s3.gifyu.com/images/heartae002231c41d8a80.png" />love open source!</p>
 </div>
 </div>
 

docs/_sources/README.md.txt

@@ -1,10 +1,8 @@
-![GitHub release](https://img.shields.io/github/release/oliver-zehentleitner/unicorn_fy.svg) 
-![GitHub](https://img.shields.io/github/license/oliver-zehentleitner/unicorn_fy.svg?color=blue) 
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/unicorn_fy.svg) 
-![PyPI - Status](https://img.shields.io/pypi/status/unicorn_fy.svg) 
-![PyPI - yes](https://img.shields.io/badge/PyPI-yes-brightgreen.svg?color=orange) 
-![PyPI - Wheel](https://img.shields.io/pypi/wheel/unicorn_fy.svg?label=PyPI%20wheel&color=orange) 
-![PyPI - Downloads](https://img.shields.io/pypi/dm/unicorn-fy.svg?label=PyPI%20downloads&color=orange)
+[![GitHub release](https://img.shields.io/github/release/oliver-zehentleitner/unicorn_fy.svg)](https://github.com/oliver-zehentleitner/unicorn_fy/releases/latest)
+[![GitHub](https://img.shields.io/github/license/oliver-zehentleitner/unicorn_fy.svg?color=blue)](https://github.com/oliver-zehentleitner/unicorn_fy/blob/master/LICENSE)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/unicorn_fy.svg)](https://www.python.org/downloads/)
+[![PyPI - Status](https://img.shields.io/pypi/status/unicorn_fy.svg)](https://github.com/oliver-zehentleitner/unicorn_fy/issues)
+[![PyPI - Wheel](https://img.shields.io/pypi/wheel/unicorn_fy.svg?label=PyPI%20wheel&color=orange)](https://pypi.org/project/unicorn-fy/)
 
 
 # UnicornFy
@@ -37,7 +35,7 @@ print(unicorn_fied_stream_data)
 ```
 Currently this module has no dependencies.
 
-If you like the project, please ![star](https://s3.gifyu.com/images/stard237b3003af9f9a9.png) it on 
+If you like the project, please [![star](https://s3.gifyu.com/images/stard237b3003af9f9a9.png)](https://github.com/oliver-zehentleitner/unicorn_fy/stargazers) it on 
 [GitHub](https://github.com/oliver-zehentleitner/unicorn_fy)! 
 
 ## Supported Exchanges
@@ -67,7 +65,8 @@ This is not a release version and can not be considered to be stable!
 `pip install https://github.com/oliver-zehentleitner/unicorn_fy/tarball/master --upgrade`
 
 ## Documentation
-[https://oliver-zehentleitner.github.io/unicorn_fy/](https://oliver-zehentleitner.github.io/unicorn_fy/)
+- [General](https://oliver-zehentleitner.github.io/unicorn_fy)
+- [Modules](https://oliver-zehentleitner.github.io/unicorn_fy/unicorn_fy.html)
 
 ## Source, Downloads, Examples, ...
 [https://github.com/oliver-zehentleitner/unicorn_fy](https://github.com/oliver-zehentleitner/unicorn_fy)
@@ -79,8 +78,9 @@ This is not a release version and can not be considered to be stable!
 [https://github.com/oliver-zehentleitner/unicorn_fy/wiki](https://github.com/oliver-zehentleitner/unicorn_fy/wiki)
 
 ## Receive Notifications
-To receive notifications on available updates you can ![watch](https://s3.gifyu.com/images/github_watch.png) the 
-repository on [GitHub](https://github.com/oliver-zehentleitner/unicorn_fy), write your 
+To receive notifications on available updates you can 
+[![watch](https://s3.gifyu.com/images/github_watch.png)](https://github.com/oliver-zehentleitner/unicorn_fy/watchers) 
+the repository on [GitHub](https://github.com/oliver-zehentleitner/unicorn_fy), write your 
 [own script](https://github.com/oliver-zehentleitner/unicorn_fy/blob/master/example_version_of_this_package.py) 
 with using `unicorn_fy.is_update_availabe()` or you use the 
 [monitoring API service](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/wiki/UNICORN-Monitoring-API-Service).