feat: prepare gh-pages on branch push (#465)

.travis.yml

@@ -1,6 +1,6 @@
 language: android
 dist: trusty
-sudo: false
+sudo: true
 jdk:
   - oraclejdk8
 android:
@@ -29,8 +29,14 @@ script:
   - ./gradlew build --stacktrace
 
 deploy:
-  provider: script
-  script: bash scripts/upload-apk.sh
-  on:
-    all_branches: true
-    condition: $TRAVIS_BRANCH =~ ^(master|development)$
+  - provider: script
+    skip_cleanup: true
+    script: bash scripts/upload-apk.sh
+    on:
+      all_branches: true
+      condition: $TRAVIS_BRANCH =~ ^(master|development)$
+  - provider: script
+    skip_cleanup: true
+    script: bash scripts/upload-gh-pages.sh
+    on:
+      all_branches: true

docs/sources/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/sources/conf.py

@@ -0,0 +1,53 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Badge Magic'
+copyright = '2019, FOSSASIA'
+author = 'FOSSASIA'
+
+master_doc = 'index'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/sources/index.rst

@@ -0,0 +1,20 @@
+.. Badge Magic documentation master file, created by
+   sphinx-quickstart on Thu Aug  8 09:11:41 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Badge Magic's documentation!
+=======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/sources/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

scripts/upload-gh-pages.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+git config --global user.name "Travis CI"
+git config --global user.email "noreply+travis@fossasia.org"
+
+sudo pip install Sphinx
+
+cd docs/sources
+
+make html
+
+git clone --quiet --branch=gh-pages https://fossasia:$GITHUB_KEY@github.com/fossasia/badge-magic-android gh-pages > /dev/null
+cd gh-pages
+
+rm -rf *
+cp -r ../_build/html/* .
+
+git checkout --orphan temporary
+
+git add --all .
+git commit -am "[Auto] Update GH-Pages from $TRAVIS_BRANCH ($(date +%Y-%m-%d.%H:%M:%S))"
+
+git branch -D gh-pages
+git branch -m gh-pages
+
+git push origin gh-pages --force --quiet > /dev/null