Migrate documentation (#12)

* updated doc url * updated version Co-authored-by: tailaiw <[email protected]>
arundo · Apr 17, 2020 · 8d539c8 · 8d539c8
1 parent 38df823
commit 8d539c8
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # tsaug
 
 [![Build Status](https://travis-ci.com/arundo/tsaug.svg?branch=master)](https://travis-ci.com/arundo/tsaug)
-[![Docs](https://readthedocs.com/projects/arundo-tsaug/badge/?version=latest)](https://arundo-tsaug.readthedocs-hosted.com/en/latest/)
+[![Documentation Status](https://readthedocs.org/projects/tsaug/badge/?version=stable)](https://tsaug.readthedocs.io/en/stable/?badge=stable)
 [![Coverage Status](https://coveralls.io/repos/github/arundo/tsaug/badge.svg?branch=master&service=github)](https://coveralls.io/github/arundo/tsaug?branch=master)
 [![PyPI](https://img.shields.io/pypi/v/tsaug)](https://pypi.org/project/tsaug/)
 [![Downloads](https://pepy.tech/badge/tsaug)](https://pepy.tech/project/tsaug)
@@ -11,7 +11,7 @@
 augmentation methods for time series, as well as a simple API to connect
 multiple augmenters into a pipeline.
 
-See https://arundo-tsaug.readthedocs-hosted.com complete documentation.
+See https://tsaug.readthedocs.io complete documentation.
 
 ## Installation
 
@@ -35,12 +35,12 @@ pip install ./
 ## Examples
 A first-time user may start with two examples:
 
-- [Augment a batch of multivariate time series](https://arundo-tsaug.readthedocs-hosted.com/en/latest/quickstart.html#augment-a-batch-of-multivariate-time-series)
-- [Augment a 2-channel audio sequence](https://arundo-tsaug.readthedocs-hosted.com/en/latest/quickstart.html#augment-a-2-channel-audio-sequence)
+- [Augment a batch of multivariate time series](https://tsaug.readthedocs.io/en/stable/quickstart.html#augment-a-batch-of-multivariate-time-series)
+- [Augment a 2-channel audio sequence](https://tsaug.readthedocs.io/en/stable/quickstart.html#augment-a-2-channel-audio-sequence)
 
-Examples of every individual augmenter can be found [here](https://arundo-tsaug.readthedocs-hosted.com/en/latest/notebook/Examples%20of%20augmenters.html)
+Examples of every individual augmenter can be found [here](https://tsaug.readthedocs.io/en/stable/notebook/Examples%20of%20augmenters.html)
 
-For full references of implemented augmentation methods, please refer to [References](https://arundo-tsaug.readthedocs-hosted.com/en/latest/references.html).
+For full references of implemented augmentation methods, please refer to [References](https://tsaug.readthedocs.io/en/stable/references.html).
 
 ## Contributing
 
@@ -49,7 +49,7 @@ discuss what you would like to change.
 
 Please make sure to update tests as appropriate.
 
-Please see [Contributing](https://arundo-tsaug.readthedocs-hosted.com/en/stable/developer.html) for more details.
+Please see [Contributing](https://tsaug.readthedocs.io/en/stable/developer.html) for more details.
 
 
 ## License

diff --git a/docs/conf.py b/docs/conf.py
@@ -30,7 +30,7 @@
 # The full version, including alpha/beta/rc tags
 version = "0.2"
 
-release = "0.2.0"
+release = "0.2.1"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/developer.rst b/docs/developer.rst
@@ -99,7 +99,7 @@ This is a guideline of managing branches and releases of tsaug.
     - An increment of patch version Z (0.Y.[Z+1]) introduces modifications that do not change the API, for example bug fix, minor changes to documentation, etc.
     - A new version is released when a set of modifications are accumulated, depending on the importance of the new functionalities and urgency of the bug fix.
     - A release is published to `PyPI <https://pypi.org/project/tsaug/>`_ and `GitHub <https://github.com/arundo/tsaug/releases>`_.
-    - The `stable documentation <https://arundo-tsaug.readthedocs-hosted.com/en/stable/>`_ corresponds to the most recent release.
+    - The `stable documentation <https://tsaug.readthedocs.io//en/stable/>`_ corresponds to the most recent release.
 
 - Pre-release versions
 
@@ -123,5 +123,5 @@ This is a guideline of managing branches and releases of tsaug.
       .. attention::
         If the modification should also be included in the next "major" release (0.[Y+1].0), a separate pull request to merge the modifications into branch **develop** should be opened.
 
-    - The `latest documentation <https://arundo-tsaug.readthedocs-hosted.com/en/latest/>`_ corresponds to the most recent pre-release in branch **develop**.
+    - The `latest documentation <https://tsaug.readthedocs.io/en/latest/>`_ corresponds to the most recent pre-release in branch **develop**.
 
diff --git a/docs/releasehistory.rst b/docs/releasehistory.rst
@@ -2,6 +2,10 @@
 Release History
 ***************
 
+Version 0.2.1 (Apr 16, 2020)
+===================================
+- Migrated the documentation to new host
+
 Version 0.2.0 (Apr 10, 2020)
 ===================================
 

diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = tsaug
-version = 0.2.0
+version = 0.2.1
 author = Arundo Analytics, Inc.
 maintainer = Tailai Wen
 maintainer_email = [email protected]

diff --git a/src/tsaug/__init__.py b/src/tsaug/__init__.py
@@ -6,11 +6,11 @@
 augmentation methods for time series, as well as a simple API to connect
 multiple augmenters into a pipeline.
 
-See https://arundo-tsaug.readthedocs-hosted.com complete documentation.
+See https://tsaug.readthedocs.io for complete documentation.
 
 """
 
-__version__ = "0.2"
+__version__ = "0.2.1"
 
 from ._augmenter.add_noise import AddNoise
 from ._augmenter.convolve import Convolve