first draft of the Yaksh read the docs documentation.

8 files changed, 253 insertions, 0 deletions

diff --git a/yaksh/documentation/_build/html/_sources/about_yaksh.txt b/yaksh/documentation/_build/html/_sources/about_yaksh.txt
new file mode 100644
index 0000000..46f0515
--- /dev/null
+++ b/yaksh/documentation/_build/html/_sources/about_yaksh.txt
@@ -0,0 +1,30 @@
+===========
+About Yaksh
+===========
+
+History
+-------
+
+At FOSSEE, Nishanth had implemented a nice django based app to test for multiple-choice questions. Prabhu Ramachandran was inspired by a programming contest that he saw at PyCon APAC 2011. Chris Boesch, who administered the contest, used a nice web application Singpath that he had built on top of GAE that basically checked your Python code, live. This made it fun and interesting.
+
+Prabhu wanted an implementation that was not tied to GAE and hence wrote the initial cut of what is now 'Yaksh'. The idea being that anyone can use this to test students programming skills and not have to worry about grading their answers manually and instead do so on their machines.
+
+The application has since been refactored and maintained by FOSSEE Developers.
+
+
+Contact
+-------
+
+For further information and support you can contact
+
+`Python Team at FOSSEE <pythonsupport@fossee.in>`_
+
+License
+-------
+This is distributed under the terms of the BSD license. Copyright information is at the bottom of this file.
+
+Authors
+-------
+
+FOSSEE Developers
+Copyright (c) 2011 FOSSEE (fossee.in)
\ No newline at end of file
diff --git a/yaksh/documentation/_build/html/_sources/index.txt b/yaksh/documentation/_build/html/_sources/index.txt
new file mode 100644
index 0000000..312fbd2
--- /dev/null
+++ b/yaksh/documentation/_build/html/_sources/index.txt
@@ -0,0 +1,23 @@
+.. Yaksh documentation master file, created by
+   sphinx-quickstart on Thu Jul  7 14:43:13 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+Welcome to Yaksh's documentation!
+=================================
+
+Yaksh lets user create and take online programming quiz.  Yaksh is an open source project developed by FOSSEE. The code is available on `github <https://github.com/fossee/online_test>`_.
+
+.. note:: 
+
+	This is a basic documentation for users to get comfortable with the interface. The documentation is still under progress. 
+	
+The user documentation for the site is organized into a few sections:
+
+.. toctree::
+
+   introduction.rst
+   installation.rst
+   moderator_dashboard.rst
+   about_yaksh.rst
\ No newline at end of file
diff --git a/yaksh/documentation/_build/html/_sources/installation.txt b/yaksh/documentation/_build/html/_sources/installation.txt
new file mode 100644
index 0000000..4acee61
--- /dev/null
+++ b/yaksh/documentation/_build/html/_sources/installation.txt
@@ -0,0 +1,67 @@
+============
+Installation
+============
+
+Installing Yaksh
+----------------
+
+
+**Pre-Requisite**
+
+* Ensure  `pip <https://pip.pypa.io/en/latest/installing.html>`_ is installed
+
+**For installing Yaksh**
+
+	* For latest stable release::
+    
+            $ pip install yaksh
+
+	* For the development version::
+
+			$ pip install git+https://github.com/FOSSEE/online_test.git
+
+Quick Start
+-----------
+
+**In the terminal run**::
+
+	yaksh create_demo [-p PATH] [project_name]
+
+* **project_name** 
+	The desired name of the django project. In case a project_name is not specified, the project is initialised with the name yaksh_demo
+* **PATH**
+	 An optional flag to specify where the django project will be installed.  If PATH is not provided, the project is created in the current directory
+
+**Now execute**::
+
+	$ yaksh run_demo
+
+This starts the web server at localhost
+
+**In a new terminal, execute**::
+
+	$ sudo yaksh run_code_server
+
+This starts the code server
+
+**Open your browser and go to URL** ::
+	
+	http://localhost:8000/exam
+
+**Login as a teacher to edit the quiz or as a student to take the quiz Credentials:**
+
+	For Student:
+		* Username: student
+		* Password: student
+
+	For Teacher:
+		* Username: teacher 
+		* Password: teacher
+
+**User can also login to the Default Django admin by going to URL**:: 
+
+		http://localhost:8000/admin
+
+**And entering the following admin credentials**
+	* Username: admin
+	* Password: admin
\ No newline at end of file
diff --git a/yaksh/documentation/_build/html/_sources/introduction.txt b/yaksh/documentation/_build/html/_sources/introduction.txt
new file mode 100644
index 0000000..78df29a
--- /dev/null
+++ b/yaksh/documentation/_build/html/_sources/introduction.txt
@@ -0,0 +1,17 @@
+============
+Introduction
+============
+
+This project provides an "exam" app that lets users take an online programming quiz.
+
+
+Features
+--------
+* Define fairly complicated programming problems and have users solve the problem.
+* Immediate verification of code solution.
+* Supports pretty much arbitrary coding questions in Python, C, C++ and simple Bash and uses "test cases" to test the implementations of the students.
+* Supports simple multiple choice questions and File uploads.
+* Since it runs on your Python, you could technically test any Python based library.
+* Scales to over 500+ simultaneous users.
+* Distributed under the BSD license.
+
diff --git a/yaksh/documentation/_build/html/_sources/moderator_dashboard.txt b/yaksh/documentation/_build/html/_sources/moderator_dashboard.txt
new file mode 100644
index 0000000..a4b2260
--- /dev/null
+++ b/yaksh/documentation/_build/html/_sources/moderator_dashboard.txt
@@ -0,0 +1,16 @@
+=====================
+Moderator's Dashboard
+=====================
+
+On logging in moderators see the following dashboard. 
+
+.. image:: images/moderator_dashboard.jpg
+
+
+The following pages explain the various functions available for moderators
+
+.. toctree::
+
+   moderator_docs/creating_course.rst
+   moderator_docs/creating_quiz.rst
+   moderator_docs/creating_question.rst
\ No newline at end of file
diff --git a/yaksh/documentation/_build/html/_sources/moderator_docs/creating_course.txt b/yaksh/documentation/_build/html/_sources/moderator_docs/creating_course.txt
new file mode 100644
index 0000000..a700971
--- /dev/null
+++ b/yaksh/documentation/_build/html/_sources/moderator_docs/creating_course.txt
@@ -0,0 +1,35 @@
+=======
+Courses
+=======
+
+For students to take a quiz, it is imperative for the moderator to create a course first. 
+
+Setting up a new course
+-----------------------
+	To create a course, click on the Add New Course button on the moderator's dashboard. This will lead you to a create add course page, where you need to fill in the following fields.
+
+		* Name 
+			Name of the Course
+		* Active 
+			If the course should be active for students to take the quiz. The status of the course can be edited later.
+		* Enrollment 
+			 Open enrollment is open to all students. Enroll Request requires students to send a request which the moderator can accept or reject.
+
+Features in Courses
+-------------------
+
+	 Click on the Courses link located at the navigation bar, to view all the courses created by the moderator.
+
+	 .. image:: ../images/course_features.jpg
+
+	 The following features are available for courses
+
+	 	* Course Name
+	 		Clicking on course name link will display all the enrolled, rejected and requested students list. Moderator can accept or reject the student.	 	
+	 	* Quiz Name
+	 		Clicking on the quiz name will let you edit the quiz.
+	 	* Add Teacher
+	 		Clicking on Add teacher can let you add teachers for the course. The teachers can edit and modify only the specific course that are allotted to them.
+	 	* View Allotted Course
+	 		Clicking on view allotted courses will display the courses the moderator is added to by other course creators.
+
diff --git a/yaksh/documentation/_build/html/_sources/moderator_docs/creating_question.txt b/yaksh/documentation/_build/html/_sources/moderator_docs/creating_question.txt
new file mode 100644
index 0000000..5e43b8d
--- /dev/null
+++ b/yaksh/documentation/_build/html/_sources/moderator_docs/creating_question.txt
@@ -0,0 +1,6 @@
+=========
+Questions
+=========
+
+
+
diff --git a/yaksh/documentation/_build/html/_sources/moderator_docs/creating_quiz.txt b/yaksh/documentation/_build/html/_sources/moderator_docs/creating_quiz.txt
new file mode 100644
index 0000000..bf82e4d
--- /dev/null
+++ b/yaksh/documentation/_build/html/_sources/moderator_docs/creating_quiz.txt
@@ -0,0 +1,59 @@
+=======
+Quizzes
+=======
+
+Quizzes are intrinsically associated with a course, hence to view and/or edit a quiz, we need to navigate to the courses page.
+
+
+
+
+Creating a Quiz
+---------------	
+	.. image:: ../images/add_quiz.jpg
+	
+	.. note :: It is important to have created or uploaded questions before creating a quiz. Click here to know how to add questions.
+
+	In courses click on **Add Quiz** button to add a quiz.
+	
+	* **Course** - Select a course from Course field. This field is mandatory.
+	* **Start Date and Time of quiz** - The date and time after which the quiz can be taken.
+	* **End Date and Time of quiz** - The date and time after which the quiz is deactivated and cannot be attempted.
+	* **Duration** - Duration of quiz to be written in minutes.
+	* **Active** - If the quiz is active or not.
+	* **Description** - Description or name of the quiz.
+	* **Passing Percentage** - Minimum percentage required to pass the test.
+	* **Prerequisite** - Set a prerequisite quiz to be passed before attempting the current quiz.
+	* **Language** - Programming language on which the quiz is based.
+	* **Attempts allowed** - Number of attempts that a student can take of the current quiz.
+	* **Number of Days** - Number of days between attempts. 
+
+	Once a quiz parameters have been set click on **design questionpaper** button to add questions into a quiz.
+
+
+Designing Question Paper
+------------------------
+
+	.. image:: ../images/design_questionpaper.jpg
+
+	A quiz can have fixed as well as random questions. Fixed questions are those question that are bound to appear for every student taking the quiz. In random questions a pool of questions is given and number of questions to be picked from the pool is set. Hence for different students, different questions from the pool will appear.
+
+	To add questions to a questionpaper 
+
+	* Select Question type and marks and a list of questions will be displayed will be in the **select questions to add** section. Do this for both fixed questions and random questions.
+
+	* Select shuffle paper if you want to jumble up the question sequence for every student and for every attempt.
+	* Click on save question paper to save it or preview question paper to preview it.
+
+
+Editing a Quiz
+--------------
+
+	In Courses page, click on the quiz link to edit the quiz. Then change the parameters and click on design question paper to save it. This will redirect you to the moderator dashboard.
+
+	In edit quiz you can also attempt the quiz in two modes - 
+		* **God Mode** - In God mode you can attempt quiz without any time or eligibilty constraints.
+		* **User Mode** - In user mode you can attempt quiz the way normal users will attempt i.e.
+			
+			* Quiz will have the same duration as that of the original quiz.
+			* Quiz won't start if the course is inactive or the quiz time has expired.
+			* You will be notified about quiz prerequisites.(You can still attempt the quiz though)
\ No newline at end of file