Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RamezIssac committed Sep 25, 2023
1 parent 18fd509 commit 5dd423b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 19 deletions.
38 changes: 19 additions & 19 deletions docs/source/concept.rst
Original file line number Diff line number Diff line change
@@ -1,37 +1,42 @@
.. _structure:

How the documentation is organized
==================================
Welcome to Django Slick Reporting documentation!
==================================================

:ref:`Tutorial <tutorial>`
--------------------------
Django Slick Reporting a reporting engine allowing you to create and chart different kind of analytics from your model in a breeze.

Demo site
---------

If you are new to Django Slick Reporting, start here. It's a step-by-step guide to building a simple report(s).
If you haven't yet, please check https://django-slick-reporting.com for a quick walk-though with live code examples..


:ref:`How-to guides <how_to>`
-----------------------------

Practical, hands-on guides that show you how to achieve a specific goal with Django Slick Reporting. Like customizing the form, creating a computation field, etc.
:ref:`Tutorial <tutorial>`
--------------------------

The tutorial will guide you to what is slick reporting, what kind of reports it can do for you and how to use it in your project.



:ref:`Topic Guides <topics>`
----------------------------

Discuss each type of reports you can create with Django Slick Reporting and their options.
Discuss each type of report main structures you can create with Django Slick Reporting and their options.

* :ref:`Grouped report <group_by_topic>`: Similar to what we'd do with a GROUP BY sql statement. We group by a field and do some kind of calculations over the grouped records.
* :ref:`time_series`: A step up from the grouped report, where the calculations are computed for each time period (day, week, month, etc).
* :ref:`crosstab_reports`: Where the results shows the relationship between two or more variables. Example: Rows are the clients, columns are the products, and the intersection values are the sum of sales for each client and product combination. This report can be created in time series as well. Example: Rows are the clients, columns are the products, and the intersection values are the sum of sales for each client and product combination, for each month.
* :ref:`list_reports`: Similar to a django changelist, it's a direct view of the report model records with some extra features like sorting, filtering, pagination, etc.
* :ref:`Group By report <group_by_topic>`: Similar to what we'd do with a GROUP BY sql statement. We group by a field and do some kind of calculations over the grouped records.
* :ref:`time_series`: A step further, where the calculations are computed for time periods (day, week, month, custom etc).
* :ref:`crosstab_reports`: Where the results shows the relationship between two or more variables. It's a table that shows the distribution of one variable in rows and another in columns.
* :ref:`list_reports`: Similar to a django admin's changelist, it's a direct view of the report model records
* And other topics like how to customize the form, and extend the exporting options.


:ref:`Reference <reference>`
----------------------------

Detailed information about main on Django Slick Reporting's main components, such as the :ref:`Report View <report_view_options>`, :ref:`Generator <report_generator>`, :ref:`Computation Field <computation_field>`, etc.
Detailed information about main on Django Slick Reporting's main components

#. :ref:`Settings <settings>`: The settings you can use to customize the behavior of Django Slick Reporting.
#. :ref:`Report View <report_view_options>`: A ``FormView`` CBV subclass with reporting capabilities allowing you to create different types of reports in the view.
It provide a default :ref:`Filter Form <filter_form>` to filter the report on.
It mimics the Generator API interface, so knowing one is enough to work with the other.
Expand All @@ -46,8 +51,3 @@ Detailed information about main on Django Slick Reporting's main components, suc




Demo site
---------

If you haven't yet, please check https://django-slick-reporting.com for a quick walk-though with live code examples..
1 change: 1 addition & 0 deletions docs/source/ref/settings.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.. _ settings:

Settings
========
Expand Down

0 comments on commit 5dd423b

Please sign in to comment.