Skip to content

Commit

Permalink
updated docs for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
@CaptainDario
CaptainDario committed May 28, 2021
1 parent 50364cb commit 0a217b1
Show file tree
Hide file tree
Showing 23 changed files with 92 additions and 45 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# ETL Data Reader : Changelog

## v 2.1.2

fixed:
- `save_to` crashes when some special characters should be saved to file
- certain images were not saved correctly (were saved completely black)

------------------------------------------------------------
## v 2.1.1

fixed:
Expand Down
2 changes: 1 addition & 1 deletion docs/build/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 801aa5ef8d2f95f206f3cfc893bb2827
config: 736bcd7f38135bac932ee6dcc0de3dc9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/build/.doctrees/CHANGELOG.doctree
View file
Binary file not shown.
Binary file modified docs/build/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/build/.doctrees/etl_data_reader.doctree
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/build/API.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>API &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand Down Expand Up @@ -34,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="getting_started.html" title="Getting started"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API</a></li>
</ul>
</div>
Expand Down Expand Up @@ -107,7 +107,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="getting_started.html" title="Getting started"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API</a></li>
</ul>
</div>
Expand Down
16 changes: 13 additions & 3 deletions docs/build/CHANGELOG.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ETL Data Reader : Changelog &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>ETL Data Reader : Changelog &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand All @@ -30,7 +30,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="indices_and_tables.html" title="Indices and tables"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">ETL Data Reader : Changelog</a></li>
</ul>
</div>
Expand All @@ -42,6 +42,15 @@ <h3>Navigation</h3>

<div class="section" id="etl-data-reader-changelog">
<h1>ETL Data Reader : Changelog<a class="headerlink" href="#etl-data-reader-changelog" title="Permalink to this headline"></a></h1>
<div class="section" id="v-2-1-2">
<h2>v 2.1.2<a class="headerlink" href="#v-2-1-2" title="Permalink to this headline"></a></h2>
<p>fixed:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">save_to</span></code> crashes when some special characters should be saved to file</p></li>
<li><p>certain images were not saved correctly (were saved completely black)</p></li>
</ul>
</div>
<hr class="docutils" />
<div class="section" id="v-2-1-1">
<h2>v 2.1.1<a class="headerlink" href="#v-2-1-1" title="Permalink to this headline"></a></h2>
<p>fixed:</p>
Expand Down Expand Up @@ -99,6 +108,7 @@ <h2>v 1.0:<a class="headerlink" href="#v-1-0" title="Permalink to this headline"
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ETL Data Reader : Changelog</a><ul>
<li><a class="reference internal" href="#v-2-1-2">v 2.1.2</a></li>
<li><a class="reference internal" href="#v-2-1-1">v 2.1.1</a></li>
<li><a class="reference internal" href="#v-2-1">v 2.1</a></li>
<li><a class="reference internal" href="#v-2-0">v 2.0:</a></li>
Expand Down Expand Up @@ -143,7 +153,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="indices_and_tables.html" title="Indices and tables"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">ETL Data Reader : Changelog</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ETLCDB_data_reader &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>ETLCDB_data_reader &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand All @@ -26,7 +26,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">ETLCDB_data_reader</a></li>
</ul>
</div>
Expand Down Expand Up @@ -441,7 +441,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">ETLCDB_data_reader</a></li>
</ul>
</div>
Expand Down
11 changes: 11 additions & 0 deletions docs/build/_sources/CHANGELOG.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@
ETL Data Reader : Changelog
===========================

v 2.1.2
-------

fixed:


* ``save_to`` crashes when some special characters should be saved to file
* certain images were not saved correctly (were saved completely black)

----

v 2.1.1
-------

Expand Down
2 changes: 1 addition & 1 deletion docs/build/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '2.1.1',
VERSION: '2.1.2',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 deletions docs/build/etl_character_groups.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>etl_character_groups.py &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>etl_character_groups.py &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand Down Expand Up @@ -34,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="API.html" title="API"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_character_groups.py</a></li>
</ul>
Expand Down Expand Up @@ -146,7 +146,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="API.html" title="API"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_character_groups.py</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/etl_codes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>etl_codes.py &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>etl_codes.py &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand Down Expand Up @@ -34,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="etl_character_groups.html" title="etl_character_groups.py"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_codes.py</a></li>
</ul>
Expand Down Expand Up @@ -249,7 +249,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="etl_character_groups.html" title="etl_character_groups.py"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_codes.py</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/etl_data_names.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>etl_data_names.py &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>etl_data_names.py &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand Down Expand Up @@ -34,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="etl_codes.html" title="etl_codes.py"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_data_names.py</a></li>
</ul>
Expand Down Expand Up @@ -187,7 +187,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="etl_codes.html" title="etl_codes.py"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_data_names.py</a></li>
</ul>
Expand Down
13 changes: 10 additions & 3 deletions docs/build/etl_data_reader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>etl_data_reader.py &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>etl_data_reader.py &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand Down Expand Up @@ -34,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="etl_data_names.html" title="etl_data_names.py"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_data_reader.py</a></li>
</ul>
Expand Down Expand Up @@ -372,6 +372,13 @@ <h3>Navigation</h3>
<dt id="etl_data_reader.ETLDataReader.save_to_file">
<code class="sig-name descname">save_to_file</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span><span class="p">:</span> <span class="n">numpy.ndarray</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">numpy.ndarray</span></em>, <em class="sig-param"><span class="n">save_to</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span><a class="headerlink" href="#etl_data_reader.ETLDataReader.save_to_file" title="Permalink to this definition"></a></dt>
<dd><p>Saves all images and labels to file.</p>
<p>Creates a folder structure in which all images for one label are
stored in a folder. The names of these folders are the labels encoded
as an int.
Additionally a file “encoding.txt” is saved. This file contains a string
representaiton of a dict to convert from the int encoding to the matching
string label. It can be restored with loading the string from disk and than
calling <cite>eval()</cite> or <cite>ast.literal_eval()</cite> on this string.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Throws an FileNotFoundError if the path to save the images to is not valid.</p>
Expand Down Expand Up @@ -460,7 +467,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="etl_data_names.html" title="etl_data_names.py"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_data_reader.py</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/etl_data_set_info.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>etl_data_set_info.py &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>etl_data_set_info.py &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand Down Expand Up @@ -34,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="etl_data_reader.html" title="etl_data_reader.py"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" accesskey="U">API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_data_set_info.py</a></li>
</ul>
Expand Down Expand Up @@ -141,7 +141,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="etl_data_reader.html" title="etl_data_reader.py"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="API.html" >API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">etl_data_set_info.py</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>Index &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand All @@ -26,7 +26,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down Expand Up @@ -343,7 +343,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/getting_started.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Getting started &#8212; ETL_data_reader 2.1.1 documentation</title>
<title>Getting started &#8212; ETL_data_reader 2.1.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

Expand Down Expand Up @@ -34,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="index.html" title="Welcome to ETL_data_reader’s documentation!"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Getting started</a></li>
</ul>
</div>
Expand Down Expand Up @@ -465,7 +465,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="index.html" title="Welcome to ETL_data_reader’s documentation!"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">ETL_data_reader 2.1.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Getting started</a></li>
</ul>
</div>
Expand Down
Loading

0 comments on commit 0a217b1

Please sign in to comment.