Merge pull request #51 from LeapBeyond/release/1.2.2

Create a new release

Author: thomasbird

.readthedocs.yml

@@ -0,0 +1,16 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - requirements: requirements/python-dev

README.rst

@@ -1,11 +1,12 @@
 
 .. NOTES FOR CREATING A RELEASE:
 ..
-..   * bump the version number
+..   * bump the version number in scrubadub/__init__.py
 ..   * update docs/changelog.rst
 ..   * git push
-..   * python setup.py sdist upload
 ..   * create a release https://github.com/LeapBeyond/scrubadub/releases
+..      * This should trigger a github action to upload to pypi
+..      * ReadTheDocs.io should see any changes and also rebuild the docs
 
 
 scrubadub

docs/changelog.rst

@@ -11,6 +11,19 @@ latest changes in development for next release
 
 .. THANKS FOR CONTRIBUTING; MENTION WHAT YOU DID IN THIS SECTION HERE!
 
+1.2.2
+-----
+
+`LeapBeyond <http://leapbeyond.ai/>`_ are now supporting scrubadub with maintanance and development.
+
+* bug fixes:
+
+  * StopIteration no longer supported in recent python varions (`#41`_ via `@roman-y-korolev`_)
+
+  * Fix test runner with python 3 (`#42`_ via `@roman-y-korolev`_)
+
+  * Update documentation to reflect new repository location (`#49`_)
+
 1.2.1
 -----
 
@@ -112,4 +125,7 @@ latest changes in development for next release
 .. _#29: https://github.com/LeapBeyond/scrubadub/issues/29
 .. _#31: https://github.com/LeapBeyond/scrubadub/pull/31
 .. _#32: https://github.com/LeapBeyond/scrubadub/pull/32
+.. _#41: https://github.com/LeapBeyond/scrubadub/pull/41
+.. _#42: https://github.com/LeapBeyond/scrubadub/pull/42
 .. _#43: https://github.com/LeapBeyond/scrubadub/pull/43
+.. _#49: https://github.com/LeapBeyond/scrubadub/pull/49

docs/index.rst

@@ -49,7 +49,7 @@ incorporating it into your python scripts like this:
 
 
 There are many ways to tailor the behavior of ``scrubadub`` using
-:ref:`different ``Detector`` and ``Filth`` classes <under_the_hood>`. These
+:ref:`different Detector and Filth classes <under_the_hood>`. These
 :ref:`advanced techniques <advanced_usage>` allow users to fine-tune the manner
 in which ``scrubadub`` cleans dirty dirty text.
 

requirements/python-dev

@@ -1,5 +1,4 @@
-# install everything in the python requirements too. this may be
-# needed by readthedocs?!?!
+# install everything in the python requirements too.
 -r python
 
 # needed for tests/run.py script to read .travis.yml file

scrubadub/__init__.py

@@ -4,7 +4,7 @@
 from . import filth
 from . import detectors
 
-__version__ = VERSION = "1.2.1"
+__version__ = VERSION = "1.2.2"
 
 
 def clean(text, cls=None, **kwargs):