Merge pull request KoalixSwitzerland#210 from scaphilo/Feature_Issue154

Feature issue154

Author: scaphilo

documentation/source/code_documentation.rst

@@ -0,0 +1,13 @@
+Code Documentation
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   code_documentation/project
+   code_documentation/task
+   code_documentation/work
+   code_documentation/estimation
+   code_documentation/agreement
+   code_documentation/resource
+

documentation/source/code_documentation/agreement.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Agreement
+---------
+
+.. automodule:: koalixcrm.crm.reporting.agreement
+   :members:
+

documentation/source/code_documentation/estimation.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Estimation
+----------
+
+.. automodule:: koalixcrm.crm.reporting.estimation
+   :members:
+

documentation/source/code_documentation/project.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Project
+-------
+
+.. automodule:: koalixcrm.crm.reporting.project
+   :members:
+

documentation/source/code_documentation/resource.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Resource
+--------
+
+.. automodule:: koalixcrm.crm.reporting.resource
+   :members:
+

documentation/source/code_documentation/task.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Task
+----
+
+.. automodule:: koalixcrm.crm.reporting.task
+   :members:
+

documentation/source/code_documentation/work.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Work
+----
+
+.. automodule:: koalixcrm.crm.reporting.work
+   :members:
+

documentation/source/conf.py

@@ -14,13 +14,21 @@
 # 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.append(os.path.abspath('.'))
+import os
+import sys
+import django
+
+sys.path.insert(0, os.path.abspath('../..'))
+os.environ['DJANGO_SETTINGS_MODULE'] = 'projectsettings.settings.development_sqlite_settings'
+django.setup()
 
 # -- 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 = []
+extensions = [
+    'sphinx.ext.autodoc',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']

documentation/source/index.rst

@@ -15,6 +15,7 @@ Contents:
    customisation
    architecture
    faq
+   code_documentation
 
 Indices and tables
 ==================

koalixcrm/accounting/accounting/product_categorie.py renamed to koalixcrm/accounting/accounting/product_category.py

@@ -5,8 +5,8 @@
 from koalixcrm.accounting.models import Account
 
 
-class ProductCategorie(models.Model):
-    title = models.CharField(verbose_name=_("Product Categorie Title"),
+class ProductCategory(models.Model):
+    title = models.CharField(verbose_name=_("Product Category Title"),
                              max_length=50)
     profit_account = models.ForeignKey(Account,
                                        verbose_name=_("Profit Account"),
@@ -19,14 +19,14 @@ class ProductCategorie(models.Model):
 
     class Meta:
         app_label = "accounting"
-        verbose_name = _('Product Categorie')
+        verbose_name = _('Product Category')
         verbose_name_plural = _('Product Categories')
 
     def __str__(self):
         return self.title
 
 
-class OptionProductCategorie(admin.ModelAdmin):
+class OptionProductCategory(admin.ModelAdmin):
     list_display = ('title',
                     'profit_account',
                     'loss_account')