wrote docs, I am a Pro now

Author: Bhupesh-V

.gitignore

@@ -73,6 +73,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/_static
+docs/_templates
 
 # PyBuilder
 target/

coderunner/coderunner.py

@@ -1,4 +1,8 @@
-"""coderunner helps you run your programs on Judge0's Server"""
+"""
+coderunner.py
+====================================
+The core module of CodeRunner
+"""
 import requests
 
 # language IDs on judge0, see README.md
@@ -22,10 +26,16 @@
 
 class Run:
     """
-    Initialize program data like name,expected input/output etc
+    Args:
+        - Source Code path
+        - Language
+        - Expected Output File Path
+        - Standard Input File Path
     """
 
     def __init__(self, program_name: str, lang: str, output: str, inp: str = None):
+        """Constructor method
+        """
         self.program_name = program_name
         self.lang = lang
         if lang not in languages:
@@ -40,9 +50,6 @@ def __init__(self, program_name: str, lang: str, output: str, inp: str = None):
         self.__stdout = None
 
     def __readCode(self):
-        """
-        Read Source Code & return as string
-        """
         with open(self.program_name, "r") as myfile:
             data = myfile.read()
         return data
@@ -90,18 +97,28 @@ def __submit(self):
     def getStandardOutput(self):
         """
         Return the standard output of the program
+        
+        :param: None
+        :rtype: String
         """
         return self.__stdout
 
     def getMemory(self):
         """
-        Return the memory used by the program (in bytes)
+        Return the memory used by the program (in kilobytes)
+        
+        :param: None
+        :return: Return the memory for eg 3564 KiloBytes
+        :rtype: String
         """
         return self.__memory
 
     def getError(self):
         """
         Return any error occured during program execution
+        
+        :param: None
+        :rtype: String
         """
         if self.__response["stderr"] != "":
             return self.__response["stderr"]
@@ -110,12 +127,20 @@ def getError(self):
     def getTime(self):
         """
         Return execution time used by the program
+
+        :param: None
+        :return: Returns the execution time used by Source Code for e.g 0.037 secs 
+        :rtype: String
         """
         return self.__time
 
     def getStatus(self):
         """
         Submits the program on Judge0's server and returns its status
+        
+        :param: None
+        :return: Returns either `Accepted` or `Run Time Error`
+        :rtype: String
         """
         self.program_name = self.__readCode()
         self.output = self.__readExpectedOutput()

docs/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/conf.py

@@ -0,0 +1,54 @@
+# 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:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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 = 'CodeRunner'
+copyright = '2019, Bhupesh Varshney'
+author = 'Bhupesh Varshney'
+
+# The full version, including alpha/beta/rc tags
+release = '0.3'
+
+
+# -- 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 = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon']
+
+# 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/index.rst

@@ -0,0 +1,18 @@
+Welcome to CodeRunner's documentation!
+======================================
+
+.. automodule:: coderunner.coderunner
+   :members:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/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