Documentation: update values

1 files changed, 13 insertions, 5 deletions

diff --git a/docs/generate_values_doc.py b/docs/generate_values_doc.py
index 73dc41f5e..f93ebd6dc 100644
--- a/docs/generate_values_doc.py
+++ b/docs/generate_values_doc.py
@@ -1,6 +1,6 @@
 from django.apps import apps
 from django.conf import settings
-from django.utils.translation import activate
+from django.utils.translation import activate, ugettext as _
 
 import datetime
 from jinja2 import Template
@@ -64,8 +64,12 @@ MODELS = {
     "archaeological_warehouse": ["warehouse", "container"],
 }
 
+MESSAGES = {
+    'value_only_message': _("Field only available for template generation")
+}
+
 
-def get_values(tpl_model, model, excluded, model_types):
+def get_values(tpl_model, model, excluded, model_types, messages):
     fields = {}
     related_fields = {}
     for field in model._meta.get_fields():
@@ -130,6 +134,10 @@ def get_values(tpl_model, model, excluded, model_types):
                 fields[field.name] += " - " + help_text
         else:
             print("No doc for the field: " + field.name)
+    if hasattr(model, "DOC_VALUES"):
+        for k, v in model.DOC_VALUES:
+            fields[k] = "{} - **{}**".format(
+                v, messages["value_only_message"])
 
     fields = sorted(list(fields.items()) + list(related_fields.items()))
     return {
@@ -147,12 +155,12 @@ for template_name, template_name_dest, language in TEMPLATES:
     excluded = EXCLUDED[:]
 
     address_values = get_values(tpl_model, Address, excluded=excluded,
-                                model_types=TYPES)
+                                model_types=TYPES, messages=MESSAGES)
     render_dct["ishtar_common"]["address"] = address_values
     excluded += address_values["fields"]
 
     geo_values = get_values(tpl_model, GeoItem, excluded=excluded,
-                            model_types=TYPES)
+                            model_types=TYPES, messages=MESSAGES)
     render_dct["ishtar_common"]["geoitem"] = geo_values
     excluded += geo_values["fields"]
 
@@ -162,7 +170,7 @@ for template_name, template_name_dest, language in TEMPLATES:
         for model_name in MODELS[app_name]:
             model = apps.get_app_config(app_name).get_model(model_name)
             render_dct[app_name][model_name] = get_values(
-                tpl_model, model, excluded, TYPES)
+                tpl_model, model, excluded, TYPES, messages=MESSAGES)
 
     template_name = os.path.abspath(
         settings.ROOT_PATH + "../docs/" + template_name)