Add circle ci for the documentation

Author: Guillaume Lemaitre

build_tools/circle/push_doc.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+# This script is meant to be called in the "deploy" step defined in 
+# circle.yml. See https://circleci.com/docs/ for more details.
+# The behavior of the script is controlled by environment variable defined
+# in the circle.yml in the top level folder of the project.
+
+MSG="Pushing the docs for revision for branch: $CIRCLE_BRANCH, commit $CIRCLE_SHA1"
+
+cd $HOME
+# Copy the build docs to a temporary folder
+rm -rf tmp
+mkdir tmp
+cp -R $HOME/$DOC_REPO/doc/_build/html/* ./tmp/ 
+
+# Clone the docs repo if it isnt already there
+if [ ! -d $DOC_REPO ];
+    then git clone "[email protected]:$USERNAME/"$DOC_REPO".git";
+fi
+
+cd $DOC_REPO
+git branch gh-pages
+git checkout -f gh-pages
+git reset --hard origin/gh-pages
+git clean -dfx
+
+for name in $(ls -A $HOME/$DOC_REPO); do
+    case $name in
+        .nojekyll) # So that github does not build this as a Jekyll website.
+        ;;
+        circle.yml) # Config so that build gh-pages branch.
+        ;;
+        *)
+        git rm -rf $name
+        ;;
+    esac
+done
+
+# Copy the new build docs
+mkdir $DOC_URL
+cp -R $HOME/tmp/* ./$DOC_URL/
+
+git config --global user.email $EMAIL
+git config --global user.name $USERNAME
+git add -f ./$DOC_URL/
+git commit -m "$MSG"
+git push -f origin gh-pages
+if [ $? -ne 0 ]; then
+    echo "Pushing docs failed"
+    echo
+    exit 1
+fi
+
+echo $MSG 

circle.yml

@@ -0,0 +1,56 @@
+machine:
+  environment:
+    # The github organization or username of the repository which hosts the
+    # project and documentation.
+    USERNAME: "glemaitre"
+
+    # The repository where the documentation will be hosted
+    DOC_REPO: "UnbalancedDataset"
+
+    # The base URL for the Github page where the documentation will be hosted
+    DOC_URL: ""
+
+    # The email is to be used for commits in the Github Page
+    EMAIL: "[email protected]"
+
+dependencies:
+
+  # Various dependencies
+  pre:
+    - sudo -E apt-get -yq remove texlive-binaries --purge
+    - sudo apt-get update
+    - sudo apt-get install libatlas-dev libatlas3gf-base
+    - sudo apt-get install build-essential python-dev python-setuptools
+    # install numpy first as it is a compile time dependency for other packages
+    - pip install --upgrade numpy
+    - pip install --upgrade scipy matplotlib setuptools nose coverage sphinx pillow sphinx-gallery sphinx_rtd_theme
+    # Installing required packages for `make -C doc check command` to work.
+    - sudo -E apt-get -yq update
+    - sudo -E apt-get -yq --no-install-suggests --no-install-recommends --force-yes install dvipng texlive-latex-base texlive-latex-extra
+    - pip install --upgrade cython numpydoc
+    - pip install --upgrade scikit-learn
+
+  # The --user is needed to let sphinx see the source and the binaries
+  # The pipefail is requested to propagate exit code
+  override:
+    - python setup.py clean
+    - python setup.py develop
+    - set -o pipefail && cd doc && make html 2>&1 | tee ~/log.txt
+test:
+  # Grep error on the documentation
+  override:
+    - cat ~/log.txt && if grep -q "Traceback (most recent call last):" ~/log.txt; then false; else true; fi
+deployment:
+  push:
+    branch: master
+    commands:
+      - bash build_tools/circle/push_doc.sh
+general:
+  # Open the doc to the API
+  artifacts:
+    - "doc/_build/html"
+    - "~/log.txt"
+  # Restric the build to the branch master only
+  branches:
+    ignore:
+- gh-pages

doc/Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = ../../UnbalancedDataset-docs
+BUILDDIR      = _build
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)