Release notes and version adjustments

milcent · Feb 2, 2020 · 181c282 · 181c282
1 parent 1010942
commit 181c282
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 7 deletions.
diff --git a/Demo.ipynb b/Demo.ipynb
@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Current version: 0.2.0"
+    "### Current version: 0.2.5"
    ]
   },
   {
@@ -37,6 +37,13 @@
     "##### `$ git clone http://github.com/milcent/Benford_py.git`"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## [Documentation](https://benford-py.readthedocs.io)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -2598,7 +2605,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,

diff --git a/README.md b/README.md
@@ -1,12 +1,17 @@
 # Benford for Python
 
-`current version = 0.2.1`
+`current version = 0.2.5`
 
 ## New in this version
 
+- Lib separated in submodules, for better organization, debugging, and further documentation and testing; and
+- Debuted documentation with sphinx and [ReadTheDocs](https://benford-py.readthedocs.io). Mostly the docstrings autodocs functionality for now, but better than nothing.
+
+### In version 0.2.1
+
 ### Bug fixes (see [release notes](https://github.com/milcent/benford_py/releases/tag/v0.2.1))
 
-## New in version 0.2.0
+## In version 0.2.0
 
 - New Mantissas object, with methods `report`, `show_plot` and `arc_test`, which shows the [Arc Test and Plot](https://github.com/milcent/benford_py/pull/24) (the latter thanks to @im-alexandre);
 - Future Deprecation of the `inform` parameter in favor of `verbose` or `report`, dependeing on the caase; and

diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -14,3 +14,12 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+On GitHub
+---------
+
+`Package <https://github.com/milcent/benford_py>`_
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Demo Jupyter Notebook <https://github.com/milcent/benford_py/blob/master/Demo.ipynb>`_
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -171,6 +171,15 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
 <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
 <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
 </ul>
+<div class="section" id="on-github">
+<h2>On GitHub<a class="headerlink" href="#on-github" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="id1">
+<h3><a class="reference external" href="https://github.com/milcent/benford_py">Package</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="id2">
+<h3><a class="reference external" href="https://github.com/milcent/benford_py/blob/master/Demo.ipynb">Demo Jupyter Notebook</a><a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
 </div>
 
 

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,3 +14,12 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+On GitHub
+---------
+
+`Package <https://github.com/milcent/benford_py>`_
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Demo Jupyter Notebook <https://github.com/milcent/benford_py/blob/master/Demo.ipynb>`_
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/setup.py b/setup.py
@@ -1,10 +1,10 @@
 from setuptools import setup
 
 setup(name='benford_py',
-      version='0.2.1',
+      version='0.2.5',
       description='A library for testing data sets with Bendford\'s Law',
       url='https://github.com/milcent/benford_py',
-      download_url='https://github.com/milcent/benford_py/archive/v0.2.1.tar.gz',
+      download_url='https://github.com/milcent/benford_py/archive/v0.2.5.tar.gz',
       author='Marcel Milcent',
       author_email='marcelmilcent@gmail.com',
       license='GPLv3.0',