Added Documentation

apps/projects/admin.py

@@ -1,5 +1,5 @@
 from django.contrib import admin
-from models import *
+from .models import *
 
 admin.site.register(Project)
 admin.site.register(Issue)

apps/projects/forms.py

@@ -1,4 +1,4 @@
-from models import *
+from .models import *
 from django import forms
 from django.forms.utils import ErrorList
 from django.forms import widgets

apps/projects/models.py

@@ -6,7 +6,7 @@
 from django.db.models.signals import post_save
 from django.dispatch import receiver
 from boto.s3.connection import S3Connection
-from cStringIO import StringIO
+from io import StringIO
 from PIL import Image as pil
 import os
 import pytz
@@ -339,7 +339,7 @@ def compress_image(sender, instance=None, created=False, **kwargs):
             if instance.image:
                 start_compressing(str(instance.image))
         except:
-            print 'Compression failed'
+            print('Compression failed')
 
 
 @receiver(post_save, sender=GalleryPicture)
@@ -349,4 +349,4 @@ def compress_image(sender, instance=None, created=False, **kwargs):
             if instance.image:
                 start_compressing(str(instance.image))
         except:
-            print 'Compression failed'
+            print('Compression failed')

apps/projects/views.py

@@ -3,7 +3,7 @@
 from django.contrib.auth.decorators import login_required
 from django.http import Http404
 from apps.projects.models import *
-from forms import *
+from .forms import *
 
 
 @login_required
@@ -1313,7 +1313,7 @@ def issues_visualisations_details(request, pk):
                     'Twitter': IssueComment.objects.filter(input_channel='Twitter', issue__id=int(pk)).count(),
                     'Offline': IssueComment.objects.filter(input_channel='Offline', issue__id=int(pk)).count(),
             }
-            print channel_graph
+            print(channel_graph)
             num_of_unresolved = IssueComment.objects.filter(issue_resolved=False, issue__id=int(pk)).count()
             num_of_resolved = IssueComment.objects.filter(issue_resolved=True, issue__id=int(pk), rating__value__lt=3).count()
             latest = IssueComment.objects.all().order_by('-id')[:5]
@@ -1334,7 +1334,7 @@ def issues_visualisations_details(request, pk):
                     'Twitter': IssueComment.objects.filter(input_channel='Twitter', issue__project__id=request.user.project_id, issue__id=int(pk)).count(),
                     'Offline': IssueComment.objects.filter(input_channel='Offline', issue__project__id=request.user.project_id, issue__id=int(pk)).count(),
                 }
-                print channel_graph
+                print(channel_graph)
                 if myratings:
                     for item in myratings:
                         rating_graph[item.name] = IssueComment.objects.filter(rating__name=item.name, issue__project__id=request.user.project_id, issue__id=int(pk)).count()

apps/users/migrations/0020_auto_20161122_0652.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('users', '0019_auto_20160910_2247'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='kakuser',
+            name='email',
+            field=models.EmailField(default=b'eBdYtP2Mx6@gmail.com', unique=True, max_length=255, verbose_name='email address'),
+        ),
+    ]

apps/users/models.py

@@ -77,7 +77,7 @@ def unique_code():
     CHARSET = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
     LENGTH = 10
     new_code = ''
-    for i in xrange(LENGTH):
+    for i in range(LENGTH):
         new_code += CHARSET[randrange(0, len(CHARSET))]
     return '%s@gmail.com' % new_code
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = Kakum
+SOURCEDIR     = source
+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/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=Kakum
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.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%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+#
+# Kakum documentation build configuration file, created by
+# sphinx-quickstart on Mon Aug 28 14:18:27 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.
+
+# 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('.'))
+
+
+# -- 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 = ['sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode']
+
+# 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 master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Kakum'
+copyright = u'2017, Penplusbytes'
+author = u'Penplusbytes'
+
+# 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'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0'
+
+# 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
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- 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 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Kakumdoc'
+
+
+# -- 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, 'Kakum.tex', u'Kakum Documentation',
+     u'Penplusbytes', 'manual'),
+]
+
+
+# -- 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, 'kakum', u'Kakum Documentation',
+     [author], 1)
+]
+
+
+# -- 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, 'Kakum', u'Kakum Documentation',
+     author, 'Kakum', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+

docs/source/index.rst

@@ -0,0 +1,27 @@
+.. Kakum documentation master file, created by
+   sphinx-quickstart on Mon Aug 28 14:18:27 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Kakum's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+	Introduction
+	Installation
+	Settings
+	Establishing Kakum
+	Using Kakum
+	User Management
+	Indices and Tables
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`