From 7d6392906cc9e11c869eae44c4e15eefb1bd9e6a Mon Sep 17 00:00:00 2001
From: isht3 <4darshofficial@gmail.com>
Date: Fri, 29 Jun 2018 16:45:59 +0530
Subject: [PATCH] Introduction and Installation instructions docs

---
 docs/conf.py           | 13 ++++++++-----
 docs/configure-host.md | 37 +++++++++++++++++++++++++++++++++++++
 docs/index.rst         |  4 +++-
 docs/installation.md   | 15 +++++++++++++++
 docs/introduction.md   | 13 +++++++++++++
 5 files changed, 76 insertions(+), 6 deletions(-)
 create mode 100644 docs/configure-host.md
 create mode 100644 docs/installation.md
 create mode 100644 docs/introduction.md

diff --git a/docs/conf.py b/docs/conf.py
index 319fcd93b..9358ad3a6 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -14,7 +14,7 @@
 #
 import os
 import sys
-import sphinx_rtd_theme
+from recommonmark.parser import CommonMarkParser
 
 
 sys.path.insert(0, os.path.abspath('../'))
@@ -44,6 +44,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -52,8 +53,8 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'
@@ -73,14 +74,16 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+source_parsers = {
+    '.md': CommonMarkParser,
+}
 
 # -- 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 = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
diff --git a/docs/configure-host.md b/docs/configure-host.md
new file mode 100644
index 000000000..584120782
--- /dev/null
+++ b/docs/configure-host.md
@@ -0,0 +1,37 @@
+# Configuring the CLI.
+
+## Configure the Host URL
+
+Before you can start using the EvalAI-CLI to do operations, you have to configure the host URL of the EvalAI instance that you want to connect to.
+
+In the rest of this docs, we would be using `http://evalapi.cloudcv.org/` URL which is where the backend for the EvalAI server is hosted.
+
+We need to configure our CLI to work with this backend.
+
+`evalai configure -sh http://evalapi.cloudcv.org/`
+
+Now, the CLI is ready to communicate with the backend. If you want to reconfigure the CLI with a different instance of EvalAI, you can use the same command.
+
+## Token Authentication
+
+Now, you have to get your own unique token to connect to your own account for performing the different operations.
+
+Step 1: Go to your account in the EvalAI web app and go to you profile.
+
+Step 2: Click the `Get Authentication Token` button in your profile.
+
+Step 3: Click `Download as JSON` to download the token in a file.
+
+Step 4: In the terminal, go to you home directory.
+
+`cd ~`
+
+Step 5: Create a dedicated folder for EvalAI's configurations.
+
+`mkdir .evalai`
+
+Step 5: Copy the `token.json` into the newly created `.evalai` folder.
+
+`mv Downloads/token.json ~/.evalai`
+
+Now you're all set and ready to go!
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 3008d995b..3150e5b69 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,7 +10,9 @@ Welcome to EvalAI CLI's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-
+   introduction
+   installation
+   configure-host
 
 Indices and tables
 ==================
diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 000000000..17eb3f273
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,15 @@
+# Installation
+
+
+## Install Python pip
+
+Have the latest version of pip and preferably Python-3 installed. 
+
+`sudo apt-get install python-pip`
+
+
+## EvalAI CLI installation
+
+Install EvalAI CLI from pip.
+
+`pip install evalai`
diff --git a/docs/introduction.md b/docs/introduction.md
new file mode 100644
index 000000000..815b798ad
--- /dev/null
+++ b/docs/introduction.md
@@ -0,0 +1,13 @@
+# Welcome
+
+
+## What is [EvalAI](https://github.com/Cloud-CV/EvalAI)?
+
+EvalAI is an open source web application that helps researchers, students and data-scientists to create, collaborate and participate in various AI challenges organized round the globe.
+
+In recent years, it has become increasingly difficult to compare an algorithm solving a given task with other existing approaches. These comparisons suffer from minor differences in algorithm implementation, use of non-standard dataset splits and different evaluation metrics. By providing a central leaderboard and submission interface, we make it easier for researchers to reproduce the results mentioned in the paper and perform reliable & accurate quantitative analysis. By providing swift and robust backends based on map-reduce frameworks that speed up evaluation on the fly, EvalAI aims to make it easier for researchers to reproduce results from technical papers and perform reliable and accurate analyses.
+
+
+## What is the [EvalAI-CLI](https://github.com/Cloud-CV/EvalAI-CLI)?
+
+EvalAI CLI was designed to extend the functionality of the EvalAI web app to the command line. EvalAI CLI offers you most of the core features of the EvalAI web app on your termial, enabling you to keep the efficiency of working on a terminal, from make a submission to viewing the results of a competition without ever leaving the terminal. EvalAI CLI is cross-platform supported and is available of PyPI.