Docs for settings + enhancements

RamezIssac · Sep 24, 2023 · 83e5eeb · 83e5eeb
1 parent a2432d7
commit 83e5eeb
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 130 deletions.
diff --git a/README.rst b/README.rst
@@ -239,13 +239,6 @@ You can also use locally
 
 the ``create_entries`` command will generate data for the demo app
 
-A Preview:
-
-.. image:: https://i.ibb.co/SvxTM23/Selection-294.png
-    :target: https://i.ibb.co/SvxTM23/Selection-294.png
-    :alt: Shipped in View Page
-
-
 Documentation
 -------------
 

diff --git a/docs/source/charts.rst b/docs/source/charts.rst
diff --git a/docs/source/howto/override_filter_form.rst b/docs/source/howto/override_filter_form.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -90,8 +90,6 @@ Next step :ref:`tutorial`
    concept
    tutorial
    topics/index
-   howto/index
-   charts
    ref/index
 
 

diff --git a/docs/source/ref/settings.rst b/docs/source/ref/settings.rst
@@ -12,12 +12,12 @@ Below are the default settings for django-slick-reporting. You can override them
 
 .. code-block:: python
 
-    SLICK_REPORTING_SETTINGS_DEFAULT = {
+    SLICK_REPORTING_SETTINGS = {
         "JQUERY_URL": "https://code.jquery.com/jquery-3.7.0.min.js",
         "DEFAULT_START_DATE_TIME": datetime(
             datetime.now().year, 1, 1, 0, 0, 0, tzinfo=timezone.utc
-        ),  # 1st Jan of current year
-        "DEFAULT_END_DATE_TIME": datetime.datetime.today(),  # today
+        ),  # Default: 1st Jan of current year
+        "DEFAULT_END_DATE_TIME": datetime.datetime.today(),  # Default to today
         "FONT_AWESOME": {
             "CSS_URL": "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css",
             "ICONS": {
@@ -37,18 +37,33 @@ Below are the default settings for django-slick-reporting. You can override them
         },
     }
 
+* JQUERY_URL:
+
+    Link to the jquery file, You can use set it to False and manage the jQuery addition to your liking
+
+* DEFAULT_START_DATE_TIME
+
+    Default date time that would appear on the filter form in the start date
+
+* DEFAULT_END_DATE_TIME
+
+    Default date time that would appear on the filter form in the end date
+
+* FONT_AWESOME:
 
-*. FONT_AWESOME
     Font awesome is used to display the icon next to the chart title. You can override the following settings:
+
     1. ``CSS_URL``: URL to the font-awesome css file
     2. ``ICONS``: Icons used for different chart types.
 
-*. CHARTS:
+* CHARTS:
+
     The entry points for displaying charts on the front end.
-    YOu can add your own chart engine by adding an entry to this dictionary.
+    You can add your own chart engine by adding an entry to this dictionary.
 
 * MESSAGES:
-    The strings used in the front end. You can override them here, it also gives a chance to set and translate them per your requirements.
+
+   The strings used in the front end. You can override them here, it also gives a chance to set and translate them per your requirements.
 
 
 Old versions settings: