MAINT: add readthedocs for transition

Author: glemaitre

.circleci/config.yml

@@ -27,11 +27,11 @@ jobs:
       - attach_workspace:
           at: doc/_build/html
       - run: ls -ltrh doc/_build/html
-      - deploy:
-          command: |
-            if [[ "${CIRCLE_BRANCH}" =~ ^master$|^[0-9]+\.[0-9]+\.X$ ]]; then
-              bash ./build_tools/circle/push_doc.sh doc/_build/html
-            fi
+      # - deploy:
+      #     command: |
+      #       if [[ "${CIRCLE_BRANCH}" =~ ^master$|^[0-9]+\.[0-9]+\.X$ ]]; then
+      #         bash ./build_tools/circle/push_doc.sh doc/_build/html
+      #       fi
     filters:
       branches:
         ignore: gh-pages

.readthedocs.yml

@@ -0,0 +1,8 @@
+formats:
+  - none
+requirements_file: requirements.txt
+python:
+  pip_install: true
+  extra_requirements:
+    - tests
+    - docs

README.rst

@@ -4,7 +4,7 @@
 
 .. _scikit-learn-contrib: https://github.com/scikit-learn-contrib
 
-|Travis|_ |AppVeyor|_ |Codecov|_ |CircleCI|_ |PythonVersion|_ |Pypi|_ |Gitter|_
+|Travis|_ |AppVeyor|_ |Codecov|_ |CircleCI|_ |ReadTheDocs|_ |PythonVersion|_ |Pypi|_ |Gitter|_
 
 .. |Travis| image:: https://travis-ci.org/scikit-learn-contrib/imbalanced-learn.svg?branch=master
 .. _Travis: https://travis-ci.org/scikit-learn-contrib/imbalanced-learn
@@ -18,6 +18,9 @@
 .. |CircleCI| image:: https://circleci.com/gh/scikit-learn-contrib/imbalanced-learn.svg?style=shield&circle-token=:circle-token
 .. _CircleCI: https://circleci.com/gh/scikit-learn-contrib/imbalanced-learn/tree/master
 
+.. |ReadTheDocs| image:: https://readthedocs.org/projects/imbalanced-learn/badge/?version=latest
+.. _ReadTheDocs: https://imbalanced-learn.readthedocs.io/en/latest/?badge=latest
+
 .. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/imbalanced-learn.svg
 .. _PythonVersion: https://img.shields.io/pypi/pyversions/imbalanced-learn.svg
 

requirements.txt

@@ -1,3 +1,3 @@
-scipy>=0.13.3
 numpy>=1.8.2
-scikit-learn>=0.20
+scipy>=0.13.3
+scikit-learn>=0.20rc1

setup.py

@@ -21,7 +21,6 @@
 LICENSE = 'MIT'
 DOWNLOAD_URL = 'https://github.com/scikit-learn-contrib/imbalanced-learn'
 VERSION = __version__
-INSTALL_REQUIRES = ['numpy', 'scipy', 'scikit-learn']
 CLASSIFIERS = ['Intended Audience :: Science/Research',
                'Intended Audience :: Developers',
                'License :: OSI Approved',
@@ -36,6 +35,22 @@
                'Programming Language :: Python :: 2.7',
                'Programming Language :: Python :: 3.6',
                'Programming Language :: Python :: 3.7']
+INSTALL_REQUIRES = ['numpy>=1.8.2', 'scipy>=0.13.3', 'scikit-learn>=0.20rc1']
+EXTRAS_REQUIRE = {
+    'tests': [
+        'pytest',
+        'pytest-cov'],
+    'docs': [
+        'sphinx',
+        'sphinx-gallery',
+        'sphinx_rtd_theme',
+        'numpydoc',
+        'matplotlib',
+        'pandas',
+        'keras',
+        'tensorflow'
+    ]
+}
 
 
 setup(name=DISTNAME,
@@ -50,4 +65,5 @@
       zip_safe=False,  # the package can run out of an .egg file
       classifiers=CLASSIFIERS,
       packages=find_packages(),
-      install_requires=INSTALL_REQUIRES)
+      install_requires=INSTALL_REQUIRES,
+      extras_require=EXTRAS_REQUIRE)