From b4974863c4061348e8e48cd1782735054326eba1 Mon Sep 17 00:00:00 2001
From: Sumitra Chowdhury <chowdhury9995@gmail.com>
Date: Mon, 20 Nov 2017 23:03:31 +0530
Subject: [PATCH] Signed-off-by: Sumitra Chowdhury <chowdhury9995@gmail.com>

Add author

Add license

Add contributing guidelines

fixes #5

Signed-off-by: Sumitra Chowdhury chowdhury9995@gmail.com
---
 0001-Create-documentation-using-Sphinx.patch | 832 +++++++++++++++++++++++++++
 Docs/source/about.rst                        |  10 +
 Docs/source/commit_message.rst               |  31 +
 Docs/source/conf.py                          |   2 +-
 Docs/source/contribute.rst                   |   9 +
 Docs/source/do_your_job.rst                  |  47 ++
 Docs/source/getting_started.rst              |  17 +
 Docs/source/index.rst                        |  12 +-
 Docs/source/license.rst                      |  25 +
 Docs/source/sending_patches.rst              |  36 ++
 Docs/source/setting_up.rst                   |  68 +++
 11 files changed, 1085 insertions(+), 4 deletions(-)
 create mode 100644 0001-Create-documentation-using-Sphinx.patch
 create mode 100644 Docs/source/about.rst
 create mode 100644 Docs/source/commit_message.rst
 create mode 100644 Docs/source/contribute.rst
 create mode 100644 Docs/source/do_your_job.rst
 create mode 100644 Docs/source/getting_started.rst
 create mode 100644 Docs/source/license.rst
 create mode 100644 Docs/source/sending_patches.rst
 create mode 100644 Docs/source/setting_up.rst

diff --git a/0001-Create-documentation-using-Sphinx.patch b/0001-Create-documentation-using-Sphinx.patch
new file mode 100644
index 0000000..17009c0
--- /dev/null
+++ b/0001-Create-documentation-using-Sphinx.patch
@@ -0,0 +1,832 @@
+From d280c3c3f6f9eae49e18cabdd028d90896c54ff6 Mon Sep 17 00:00:00 2001
+From: Sumitra Chowdhury <chowdhury9995@gmail.com>
+Date: Wed, 15 Nov 2017 22:11:17 +0530
+Subject: [PATCH] Create documentation using Sphinx
+
+Initial commit
+
+fixes #2
+
+Signed-off-by: Sumitra Chowdhury chowdhury9995@gmail.com
+---
+ Docs/Makefile         | 216 ++++++++++++++++++++++++++++++++++++++
+ Docs/make.bat         | 263 ++++++++++++++++++++++++++++++++++++++++++++++
+ Docs/source/conf.py   | 283 ++++++++++++++++++++++++++++++++++++++++++++++++++
+ Docs/source/index.rst |  22 ++++
+ 4 files changed, 784 insertions(+)
+ create mode 100644 Docs/Makefile
+ create mode 100644 Docs/make.bat
+ create mode 100644 Docs/source/conf.py
+ create mode 100644 Docs/source/index.rst
+
+diff --git a/Docs/Makefile b/Docs/Makefile
+new file mode 100644
+index 0000000..66031a7
+--- /dev/null
++++ b/Docs/Makefile
+@@ -0,0 +1,216 @@
++# Makefile for Sphinx documentation
++#
++
++# You can set these variables from the command line.
++SPHINXOPTS    =
++SPHINXBUILD   = sphinx-build
++PAPER         =
++BUILDDIR      = build
++
++# User-friendly check for sphinx-build
++ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
++$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
++endif
++
++# Internal variables.
++PAPEROPT_a4     = -D latex_paper_size=a4
++PAPEROPT_letter = -D latex_paper_size=letter
++ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
++# the i18n builder cannot share the environment and doctrees with the others
++I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
++
++.PHONY: help
++help:
++	@echo "Please use \`make <target>' where <target> is one of"
++	@echo "  html       to make standalone HTML files"
++	@echo "  dirhtml    to make HTML files named index.html in directories"
++	@echo "  singlehtml to make a single large HTML file"
++	@echo "  pickle     to make pickle files"
++	@echo "  json       to make JSON files"
++	@echo "  htmlhelp   to make HTML files and a HTML help project"
++	@echo "  qthelp     to make HTML files and a qthelp project"
++	@echo "  applehelp  to make an Apple Help Book"
++	@echo "  devhelp    to make HTML files and a Devhelp project"
++	@echo "  epub       to make an epub"
++	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
++	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
++	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
++	@echo "  text       to make text files"
++	@echo "  man        to make manual pages"
++	@echo "  texinfo    to make Texinfo files"
++	@echo "  info       to make Texinfo files and run them through makeinfo"
++	@echo "  gettext    to make PO message catalogs"
++	@echo "  changes    to make an overview of all changed/added/deprecated items"
++	@echo "  xml        to make Docutils-native XML files"
++	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
++	@echo "  linkcheck  to check all external links for integrity"
++	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
++	@echo "  coverage   to run coverage check of the documentation (if enabled)"
++
++.PHONY: clean
++clean:
++	rm -rf $(BUILDDIR)/*
++
++.PHONY: html
++html:
++	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
++	@echo
++	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
++
++.PHONY: dirhtml
++dirhtml:
++	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
++	@echo
++	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
++
++.PHONY: singlehtml
++singlehtml:
++	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
++	@echo
++	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
++
++.PHONY: pickle
++pickle:
++	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
++	@echo
++	@echo "Build finished; now you can process the pickle files."
++
++.PHONY: json
++json:
++	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
++	@echo
++	@echo "Build finished; now you can process the JSON files."
++
++.PHONY: htmlhelp
++htmlhelp:
++	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
++	@echo
++	@echo "Build finished; now you can run HTML Help Workshop with the" \
++	      ".hhp project file in $(BUILDDIR)/htmlhelp."
++
++.PHONY: qthelp
++qthelp:
++	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
++	@echo
++	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
++	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
++	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/AIRYL.qhcp"
++	@echo "To view the help file:"
++	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/AIRYL.qhc"
++
++.PHONY: applehelp
++applehelp:
++	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
++	@echo
++	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
++	@echo "N.B. You won't be able to view it unless you put it in" \
++	      "~/Library/Documentation/Help or install it in your application" \
++	      "bundle."
++
++.PHONY: devhelp
++devhelp:
++	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
++	@echo
++	@echo "Build finished."
++	@echo "To view the help file:"
++	@echo "# mkdir -p $$HOME/.local/share/devhelp/AIRYL"
++	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/AIRYL"
++	@echo "# devhelp"
++
++.PHONY: epub
++epub:
++	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
++	@echo
++	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
++
++.PHONY: latex
++latex:
++	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
++	@echo
++	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
++	@echo "Run \`make' in that directory to run these through (pdf)latex" \
++	      "(use \`make latexpdf' here to do that automatically)."
++
++.PHONY: latexpdf
++latexpdf:
++	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
++	@echo "Running LaTeX files through pdflatex..."
++	$(MAKE) -C $(BUILDDIR)/latex all-pdf
++	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
++
++.PHONY: latexpdfja
++latexpdfja:
++	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
++	@echo "Running LaTeX files through platex and dvipdfmx..."
++	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
++	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
++
++.PHONY: text
++text:
++	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
++	@echo
++	@echo "Build finished. The text files are in $(BUILDDIR)/text."
++
++.PHONY: man
++man:
++	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
++	@echo
++	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
++
++.PHONY: texinfo
++texinfo:
++	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
++	@echo
++	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
++	@echo "Run \`make' in that directory to run these through makeinfo" \
++	      "(use \`make info' here to do that automatically)."
++
++.PHONY: info
++info:
++	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
++	@echo "Running Texinfo files through makeinfo..."
++	make -C $(BUILDDIR)/texinfo info
++	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
++
++.PHONY: gettext
++gettext:
++	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
++	@echo
++	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
++
++.PHONY: changes
++changes:
++	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
++	@echo
++	@echo "The overview file is in $(BUILDDIR)/changes."
++
++.PHONY: linkcheck
++linkcheck:
++	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
++	@echo
++	@echo "Link check complete; look for any errors in the above output " \
++	      "or in $(BUILDDIR)/linkcheck/output.txt."
++
++.PHONY: doctest
++doctest:
++	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
++	@echo "Testing of doctests in the sources finished, look at the " \
++	      "results in $(BUILDDIR)/doctest/output.txt."
++
++.PHONY: coverage
++coverage:
++	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
++	@echo "Testing of coverage in the sources finished, look at the " \
++	      "results in $(BUILDDIR)/coverage/python.txt."
++
++.PHONY: xml
++xml:
++	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
++	@echo
++	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
++
++.PHONY: pseudoxml
++pseudoxml:
++	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
++	@echo
++	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+diff --git a/Docs/make.bat b/Docs/make.bat
+new file mode 100644
+index 0000000..3f7359e
+--- /dev/null
++++ b/Docs/make.bat
+@@ -0,0 +1,263 @@
++@ECHO OFF
++
++REM Command file for Sphinx documentation
++
++if "%SPHINXBUILD%" == "" (
++	set SPHINXBUILD=sphinx-build
++)
++set BUILDDIR=build
++set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
++set I18NSPHINXOPTS=%SPHINXOPTS% source
++if NOT "%PAPER%" == "" (
++	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
++	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
++)
++
++if "%1" == "" goto help
++
++if "%1" == "help" (
++	:help
++	echo.Please use `make ^<target^>` where ^<target^> is one of
++	echo.  html       to make standalone HTML files
++	echo.  dirhtml    to make HTML files named index.html in directories
++	echo.  singlehtml to make a single large HTML file
++	echo.  pickle     to make pickle files
++	echo.  json       to make JSON files
++	echo.  htmlhelp   to make HTML files and a HTML help project
++	echo.  qthelp     to make HTML files and a qthelp project
++	echo.  devhelp    to make HTML files and a Devhelp project
++	echo.  epub       to make an epub
++	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
++	echo.  text       to make text files
++	echo.  man        to make manual pages
++	echo.  texinfo    to make Texinfo files
++	echo.  gettext    to make PO message catalogs
++	echo.  changes    to make an overview over all changed/added/deprecated items
++	echo.  xml        to make Docutils-native XML files
++	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
++	echo.  linkcheck  to check all external links for integrity
++	echo.  doctest    to run all doctests embedded in the documentation if enabled
++	echo.  coverage   to run coverage check of the documentation if enabled
++	goto end
++)
++
++if "%1" == "clean" (
++	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
++	del /q /s %BUILDDIR%\*
++	goto end
++)
++
++
++REM Check if sphinx-build is available and fallback to Python version if any
++%SPHINXBUILD% 1>NUL 2>NUL
++if errorlevel 9009 goto sphinx_python
++goto sphinx_ok
++
++:sphinx_python
++
++set SPHINXBUILD=python -m sphinx.__init__
++%SPHINXBUILD% 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
++)
++
++:sphinx_ok
++
++
++if "%1" == "html" (
++	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
++	goto end
++)
++
++if "%1" == "dirhtml" (
++	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
++	goto end
++)
++
++if "%1" == "singlehtml" (
++	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
++	goto end
++)
++
++if "%1" == "pickle" (
++	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished; now you can process the pickle files.
++	goto end
++)
++
++if "%1" == "json" (
++	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished; now you can process the JSON files.
++	goto end
++)
++
++if "%1" == "htmlhelp" (
++	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished; now you can run HTML Help Workshop with the ^
++.hhp project file in %BUILDDIR%/htmlhelp.
++	goto end
++)
++
++if "%1" == "qthelp" (
++	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished; now you can run "qcollectiongenerator" with the ^
++.qhcp project file in %BUILDDIR%/qthelp, like this:
++	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\AIRYL.qhcp
++	echo.To view the help file:
++	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\AIRYL.ghc
++	goto end
++)
++
++if "%1" == "devhelp" (
++	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished.
++	goto end
++)
++
++if "%1" == "epub" (
++	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The epub file is in %BUILDDIR%/epub.
++	goto end
++)
++
++if "%1" == "latex" (
++	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
++	goto end
++)
++
++if "%1" == "latexpdf" (
++	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
++	cd %BUILDDIR%/latex
++	make all-pdf
++	cd %~dp0
++	echo.
++	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
++	goto end
++)
++
++if "%1" == "latexpdfja" (
++	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
++	cd %BUILDDIR%/latex
++	make all-pdf-ja
++	cd %~dp0
++	echo.
++	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
++	goto end
++)
++
++if "%1" == "text" (
++	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The text files are in %BUILDDIR%/text.
++	goto end
++)
++
++if "%1" == "man" (
++	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The manual pages are in %BUILDDIR%/man.
++	goto end
++)
++
++if "%1" == "texinfo" (
++	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
++	goto end
++)
++
++if "%1" == "gettext" (
++	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
++	goto end
++)
++
++if "%1" == "changes" (
++	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.The overview file is in %BUILDDIR%/changes.
++	goto end
++)
++
++if "%1" == "linkcheck" (
++	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Link check complete; look for any errors in the above output ^
++or in %BUILDDIR%/linkcheck/output.txt.
++	goto end
++)
++
++if "%1" == "doctest" (
++	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Testing of doctests in the sources finished, look at the ^
++results in %BUILDDIR%/doctest/output.txt.
++	goto end
++)
++
++if "%1" == "coverage" (
++	%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Testing of coverage in the sources finished, look at the ^
++results in %BUILDDIR%/coverage/python.txt.
++	goto end
++)
++
++if "%1" == "xml" (
++	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The XML files are in %BUILDDIR%/xml.
++	goto end
++)
++
++if "%1" == "pseudoxml" (
++	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
++	if errorlevel 1 exit /b 1
++	echo.
++	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
++	goto end
++)
++
++:end
+diff --git a/Docs/source/conf.py b/Docs/source/conf.py
+new file mode 100644
+index 0000000..1a9c55c
+--- /dev/null
++++ b/Docs/source/conf.py
+@@ -0,0 +1,283 @@
++# -*- coding: utf-8 -*-
++#
++# AIRYL documentation build configuration file, created by
++# sphinx-quickstart on Wed Nov 15 22:10:08 2017.
++#
++# This file is execfile()d with the current directory set to its
++# containing dir.
++#
++# Note that not all possible configuration values are present in this
++# autogenerated file.
++#
++# All configuration values have a default; values that are commented out
++# serve to show the default.
++
++import sys
++import os
++
++# 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.
++#sys.path.insert(0, os.path.abspath('.'))
++
++# -- General configuration ------------------------------------------------
++
++# If your documentation needs a minimal Sphinx version, state it here.
++#needs_sphinx = '1.0'
++
++# 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']
++
++# The suffix(es) of source filenames.
++# You can specify multiple suffix as a list of string:
++# source_suffix = ['.rst', '.md']
++source_suffix = '.rst'
++
++# The encoding of source files.
++#source_encoding = 'utf-8-sig'
++
++# The master toctree document.
++master_doc = 'index'
++
++# General information about the project.
++project = u'AIRYL'
++copyright = u'2017, Sumitra Chowdhury, Rohit Das, Rudra Nil Basu, Debayan De'
++author = u'Sumitra Chowdhury, Rohit Das, Rudra Nil Basu, Debayan De'
++
++# The version info for the project you're documenting, acts as replacement for
++# |version| and |release|, also used in various other places throughout the
++# built documents.
++#
++# The short X.Y version.
++version = u'v1'
++# The full version, including alpha/beta/rc tags.
++release = u'v1.1'
++
++# The language for content autogenerated by Sphinx. Refer to documentation
++# for a list of supported languages.
++#
++# This is also used if you do content translation via gettext catalogs.
++# Usually you set "language" from the command line for these cases.
++language = None
++
++# There are two options for replacing |today|: either, you set today to some
++# non-false value, then it is used:
++#today = ''
++# Else, today_fmt is used as the format for a strftime call.
++#today_fmt = '%B %d, %Y'
++
++# List of patterns, relative to source directory, that match files and
++# directories to ignore when looking for source files.
++exclude_patterns = []
++
++# The reST default role (used for this markup: `text`) to use for all
++# documents.
++#default_role = None
++
++# If true, '()' will be appended to :func: etc. cross-reference text.
++#add_function_parentheses = True
++
++# If true, the current module name will be prepended to all description
++# unit titles (such as .. function::).
++#add_module_names = True
++
++# If true, sectionauthor and moduleauthor directives will be shown in the
++# output. They are ignored by default.
++#show_authors = False
++
++# The name of the Pygments (syntax highlighting) style to use.
++pygments_style = 'sphinx'
++
++# A list of ignored prefixes for module index sorting.
++#modindex_common_prefix = []
++
++# If true, keep warnings as "system message" paragraphs in the built documents.
++#keep_warnings = False
++
++# If true, `todo` and `todoList` produce output, else they produce nothing.
++todo_include_todos = False
++
++
++# -- 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'
++
++# 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
++# documentation.
++#html_theme_options = {}
++
++# Add any paths that contain custom themes here, relative to this directory.
++#html_theme_path = []
++
++# The name for this set of Sphinx documents.  If None, it defaults to
++# "<project> v<release> documentation".
++#html_title = None
++
++# A shorter title for the navigation bar.  Default is the same as html_title.
++#html_short_title = None
++
++# The name of an image file (relative to this directory) to place at the top
++# of the sidebar.
++#html_logo = None
++
++# The name of an image file (relative to this directory) to use as a favicon of
++# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
++# pixels large.
++#html_favicon = None
++
++# 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']
++
++# Add any extra paths that contain custom files (such as robots.txt or
++# .htaccess) here, relative to this directory. These files are copied
++# directly to the root of the documentation.
++#html_extra_path = []
++
++# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
++# using the given strftime format.
++#html_last_updated_fmt = '%b %d, %Y'
++
++# If true, SmartyPants will be used to convert quotes and dashes to
++# typographically correct entities.
++#html_use_smartypants = True
++
++# Custom sidebar templates, maps document names to template names.
++#html_sidebars = {}
++
++# Additional templates that should be rendered to pages, maps page names to
++# template names.
++#html_additional_pages = {}
++
++# If false, no module index is generated.
++#html_domain_indices = True
++
++# If false, no index is generated.
++#html_use_index = True
++
++# If true, the index is split into individual pages for each letter.
++#html_split_index = False
++
++# If true, links to the reST sources are added to the pages.
++#html_show_sourcelink = True
++
++# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
++#html_show_sphinx = True
++
++# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
++#html_show_copyright = True
++
++# If true, an OpenSearch description file will be output, and all pages will
++# contain a <link> tag referring to it.  The value of this option must be the
++# base URL from which the finished HTML is served.
++#html_use_opensearch = ''
++
++# This is the file name suffix for HTML files (e.g. ".xhtml").
++#html_file_suffix = None
++
++# Language to be used for generating the HTML full-text search index.
++# Sphinx supports the following languages:
++#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
++#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
++#html_search_language = 'en'
++
++# A dictionary with options for the search language support, empty by default.
++# Now only 'ja' uses this config value
++#html_search_options = {'type': 'default'}
++
++# The name of a javascript file (relative to the configuration directory) that
++# implements a search results scorer. If empty, the default will be used.
++#html_search_scorer = 'scorer.js'
++
++# Output file base name for HTML help builder.
++htmlhelp_basename = 'AIRYLdoc'
++
++# -- Options for LaTeX output ---------------------------------------------
++
++latex_elements = {
++# The paper size ('letterpaper' or 'a4paper').
++#'papersize': 'letterpaper',
++
++# The font size ('10pt', '11pt' or '12pt').
++#'pointsize': '10pt',
++
++# Additional stuff for the LaTeX preamble.
++#'preamble': '',
++
++# Latex figure (float) alignment
++#'figure_align': 'htbp',
++}
++
++# Grouping the document tree into LaTeX files. List of tuples
++# (source start file, target name, title,
++#  author, documentclass [howto, manual, or own class]).
++latex_documents = [
++    (master_doc, 'AIRYL.tex', u'AIRYL Documentation',
++     u'Sumitra Chowdhury, Rohit Das, Rudra Nil Basu, Debayan De', 'manual'),
++]
++
++# The name of an image file (relative to this directory) to place at the top of
++# the title page.
++#latex_logo = None
++
++# For "manual" documents, if this is true, then toplevel headings are parts,
++# not chapters.
++#latex_use_parts = False
++
++# If true, show page references after internal links.
++#latex_show_pagerefs = False
++
++# If true, show URL addresses after external links.
++#latex_show_urls = False
++
++# Documents to append as an appendix to all manuals.
++#latex_appendices = []
++
++# If false, no module index is generated.
++#latex_domain_indices = True
++
++
++# -- Options for manual page output ---------------------------------------
++
++# One entry per manual page. List of tuples
++# (source start file, name, description, authors, manual section).
++man_pages = [
++    (master_doc, 'airyl', u'AIRYL Documentation',
++     [author], 1)
++]
++
++# If true, show URL addresses after external links.
++#man_show_urls = False
++
++
++# -- Options for Texinfo output -------------------------------------------
++
++# Grouping the document tree into Texinfo files. List of tuples
++# (source start file, target name, title, author,
++#  dir menu entry, description, category)
++texinfo_documents = [
++    (master_doc, 'AIRYL', u'AIRYL Documentation',
++     author, 'AIRYL', 'One line description of project.',
++     'Miscellaneous'),
++]
++
++# Documents to append as an appendix to all manuals.
++#texinfo_appendices = []
++
++# If false, no module index is generated.
++#texinfo_domain_indices = True
++
++# How to display URL addresses: 'footnote', 'no', or 'inline'.
++#texinfo_show_urls = 'footnote'
++
++# If true, do not generate a @detailmenu in the "Top" node's menu.
++#texinfo_no_detailmenu = False
+diff --git a/Docs/source/index.rst b/Docs/source/index.rst
+new file mode 100644
+index 0000000..9553456
+--- /dev/null
++++ b/Docs/source/index.rst
+@@ -0,0 +1,22 @@
++.. AIRYL documentation master file, created by
++   sphinx-quickstart on Wed Nov 15 22:10:08 2017.
++   You can adapt this file completely to your liking, but it should at least
++   contain the root `toctree` directive.
++
++Welcome to AIRYL's documentation!
++=================================
++
++Contents:
++
++.. toctree::
++   :maxdepth: 2
++
++
++
++Indices and tables
++==================
++
++* :ref:`genindex`
++* :ref:`modindex`
++* :ref:`search`
++
+--
+2.7.4
+
diff --git a/Docs/source/about.rst b/Docs/source/about.rst
new file mode 100644
index 0000000..890492b
--- /dev/null
+++ b/Docs/source/about.rst
@@ -0,0 +1,10 @@
+About
+=====
+
+AIRYL is a chatbot using AIML
+
+Version : |version|
+
+.. toctree::
+	license.rst
+
diff --git a/Docs/source/commit_message.rst b/Docs/source/commit_message.rst
new file mode 100644
index 0000000..1fff94b
--- /dev/null
+++ b/Docs/source/commit_message.rst
@@ -0,0 +1,31 @@
+Commit your changes
+====================
+
+- Commit message must be of the form
+
+	::
+
+		shortlog: commit message
+
+		commit body
+
+		fixes #<issue_number>
+
+		Signed-off-by: [Your name] <your email>
+
+
+	- Note: add the ``git commit --signoff`` flag while committing to get the Signed-off-by line added
+
+- Write proper commit messages
+
+	| - Separate subject from body with a blank line
+	| - Limit the subject line to 50 characters
+	| - Capitalize the subject line
+	| - Do not end the subject line with a period
+	| - Use the imperative mood in the subject line
+	| - Wrap the body at 72 characters
+	| - Use the body to explain what and why vs. how
+
+	- check this_ out for more information
+	.. _this: https://chris.beams.io/posts/git-commit/
+
diff --git a/Docs/source/conf.py b/Docs/source/conf.py
index 1a9c55c..223503f 100644
--- a/Docs/source/conf.py
+++ b/Docs/source/conf.py
@@ -107,7 +107,7 @@ todo_include_todos = False

 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = 'classic'

 # 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/source/contribute.rst b/Docs/source/contribute.rst
new file mode 100644
index 0000000..86d9e8c
--- /dev/null
+++ b/Docs/source/contribute.rst
@@ -0,0 +1,9 @@
+Contributing Guidelines
+=======================
+.. toctree::
+	getting_started.rst
+	setting_up.rst
+	do_your_job.rst
+	commit_message.rst
+	sending_patches.rst
+
diff --git a/Docs/source/do_your_job.rst b/Docs/source/do_your_job.rst
new file mode 100644
index 0000000..19799e1
--- /dev/null
+++ b/Docs/source/do_your_job.rst
@@ -0,0 +1,47 @@
+Start working
+==============
+
+Clone the repository to your local machine
+-------------------------------------------
+
+.. code-block:: console
+
+		$ git clone <remote repository-link>
+
+- Create a branch while working on an issue
+
+Create a branch
+----------------
+
+.. code-block:: console
+
+		$ git branch <branch-name>
+
+- To see which branch you are on
+
+.. code-block:: console
+
+		$ git branch
+
+Switch branch
+--------------
+
+.. code-block:: console
+
+		$ git checkout <branch-name>
+
+- Do your work, commit changes, create a patch and send it using ``git-mail``
+
+- For **coding style**, follow this_
+.. _this: https://google.github.io/styleguide/javaguide.html
+
+Pull the changes from remote
+-----------------------------
+
+.. code-block:: console
+
+		$ git pull <remote repository-link> <branch-name from which you are pulling the changes>
+
+
+
+
diff --git a/Docs/source/getting_started.rst b/Docs/source/getting_started.rst
new file mode 100644
index 0000000..20a5677
--- /dev/null
+++ b/Docs/source/getting_started.rst
@@ -0,0 +1,17 @@
+================
+Getting Started
+================
+
+Install git
+-----------
+.. code-block:: console
+
+	 $ sudo apt-get install git
+
+Install git-email
+-----------------
+
+.. code-block:: console
+
+	 $ sudo-apt-get install git-email
+
diff --git a/Docs/source/index.rst b/Docs/source/index.rst
index 9553456..7b7e938 100644
--- a/Docs/source/index.rst
+++ b/Docs/source/index.rst
@@ -2,16 +2,22 @@
    sphinx-quickstart on Wed Nov 15 22:10:08 2017.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
+
+| Author : Sumitra Chowdhury
+| Contact : chowdhury9995@gmail.com

-Welcome to AIRYL's documentation!
-=================================
+================================
+Welcome to AIRYL's documentation
+================================

 Contents:
+

 .. toctree::
    :maxdepth: 2

-
+   about.rst
+   contribute.rst

 Indices and tables
 ==================
diff --git a/Docs/source/license.rst b/Docs/source/license.rst
new file mode 100644
index 0000000..f8a4cad
--- /dev/null
+++ b/Docs/source/license.rst
@@ -0,0 +1,25 @@
+=========
+License
+=========
+
+MIT License
+
+Copyright (c) 2017 PhoenixRRDS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (PhoenixRRDS), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of PhoenixRRDS, and to permit persons to whom PhoenixRRDS is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of PhoenixRRDS.
+
+PHOENIXRRDS IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+PHOENIXRRDS.
diff --git a/Docs/source/sending_patches.rst b/Docs/source/sending_patches.rst
new file mode 100644
index 0000000..784e5c8
--- /dev/null
+++ b/Docs/source/sending_patches.rst
@@ -0,0 +1,36 @@
+===============
+Sending Patches
+===============
+
+After making the changes in the source code follow the following steps
+
+	.. code-block:: console
+
+		$ git add .
+
+	.. code-block:: console
+
+		$ git commit --signoff
+
+	- add the commit message
+
+create a patch
+-------------------
+	.. code-block:: console
+
+		$ git format-patch master..<branch-name>
+
+		- It will create a patch(.patch) file
+
+Send the patch
+--------------
+
+	.. code-block:: console
+
+		- git send-mail --to <receiver's mail-id> --cc < mail-id > < name of patch file created >
+
+	- **Send patches to**
+
+		- rudra.nil.basu.1996@gmail.com
+
+		- along with a cc to the mailing list airyl@googlegroups.com
diff --git a/Docs/source/setting_up.rst b/Docs/source/setting_up.rst
new file mode 100644
index 0000000..650611b
--- /dev/null
+++ b/Docs/source/setting_up.rst
@@ -0,0 +1,68 @@
+=====================
+Set Up
+=====================
+
+Set up git-email
+-----------------
+
+- Enable IMAP and POP
+
+ 	- Open your mail in a browser.
+	- Go to the settings > Forwarding > POP/IMAP.
+	- Enable IMAP and POP.
+
+- Set up your terminal.
+
+	.. code-block:: console
+
+		$ git config --global sendemail.from "YOUR NAME <user@example.org>"
+
+	.. code-block:: console
+
+		$ git config --global sendemail.smtpserver imap.example.org
+
+	- imap.example.org will be smtp.googlemail.com for gmail
+
+	.. code-block:: console
+
+		$ git config --global sendemail.smtpuser USER
+
+	- Enter your email-id in place of USER.
+
+	.. code-block:: console
+
+		$ git config --global sendemail.smtpencryption tls
+
+	.. code-block:: console
+
+		$ git config --global sendemail.smtppass = PASS
+
+	- Enter your email password in place of PASS
+
+- check you settings.
+
+	.. code-block:: console
+
+		$ vi ~/.gitconfig
+
+	- ( It will open a new file)
+	- if not available add :-
+		- smtpserverport = 587
+		- suppresscc = self
+
+Set up  vimrc
+-------------------
+
+	.. code-block:: console
+
+		$ vim ~/.vimrc
+
+	- It will open a new file, add below given statements to that file:-
+		- set tabstop=8
+		- set shiftwidth=8
+		- set expandtab
+
+
+
+
+
--
2.7.4