Build Doc using README.md (#2965)

Author: kumuditha-udayanga

docs/sources/conf.py

@@ -28,8 +28,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-]
+extensions = ['m2r']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -50,4 +49,4 @@
 # 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']
+html_static_path = ['_static']

docs/sources/index.rst

@@ -4,6 +4,7 @@
    contain the root `toctree` directive.
 Welcome to Phimp.me's documentation!
 =======================================
+.. mdinclude:: ../../README.md
 
 .. toctree::
    :maxdepth: 2
@@ -16,4 +17,4 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`

scripts/upload-gh-pages.sh

@@ -4,11 +4,17 @@ git config --global user.name "Travis CI"
 git config --global user.email "noreply+travis@fossasia.org"
 
 sudo pip install Sphinx
+sudo pip install m2r
 
 cd docs/sources
 
 make html
 
+# Copy image files.
+mkdir _build/html/docs
+cp -r ../images _build/html/docs
+cp -r ../../fastlane _build/html
+
 git clone --quiet --branch=gh-pages https://fossasia:$GITHUB_API_KEY@github.com/fossasia/phimpme-android gh-pages > /dev/null
 cd gh-pages