diff --git a/kpi_dashboard_altair/README.rst b/kpi_dashboard_altair/README.rst index 9b5050d0d..1571d2f17 100644 --- a/kpi_dashboard_altair/README.rst +++ b/kpi_dashboard_altair/README.rst @@ -64,13 +64,23 @@ You need to define a function like:: You can use `code` in a similar way, as `pandas` and `altair` are already defined when using `code` on an `altair` widget. + +.. image:: https://raw.githubusercontent.com/akretion/reporting-engine/12-altair-readme/kpi_dashboard_altair/static/description/config.png + + +Usage +===== + + +.. figure:: https://raw.githubusercontent.com/akretion/reporting-engine/12-altair-readme/kpi_dashboard_altair/static/description/graph.png + Bug Tracker =========== Bugs are tracked on `GitHub Issues `_. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. diff --git a/kpi_dashboard_altair/__manifest__.py b/kpi_dashboard_altair/__manifest__.py index 1fc0a2ceb..e3c8fff1c 100644 --- a/kpi_dashboard_altair/__manifest__.py +++ b/kpi_dashboard_altair/__manifest__.py @@ -5,7 +5,7 @@ "name": "Kpi Dashboard Altair", "summary": """ Create dashboards using altair""", - "version": "12.0.1.0.1", + "version": "12.0.1.0.2", "license": "AGPL-3", "author": "Creu Blanca,Odoo Community Association (OCA)", "website": "https://github.com/OCA/reporting-engine", @@ -13,8 +13,9 @@ "data": ["views/webclient_templates.xml"], "qweb": ["static/src/xml/dashboard.xml"], "external_dependencies": { - "python": ['altair'], + "python": ["altair"], }, "demo": ["demo/demo_dashboard_altair.xml"], + "maintainers": ["etobella"], } diff --git a/kpi_dashboard_altair/readme/CONFIGURE.rst b/kpi_dashboard_altair/readme/CONFIGURE.rst index 382e3d0b4..0023b9184 100644 --- a/kpi_dashboard_altair/readme/CONFIGURE.rst +++ b/kpi_dashboard_altair/readme/CONFIGURE.rst @@ -26,3 +26,7 @@ You need to define a function like:: You can use `code` in a similar way, as `pandas` and `altair` are already defined when using `code` on an `altair` widget. + + +.. image:: ../static/description/config.png + diff --git a/kpi_dashboard_altair/readme/USAGE.rst b/kpi_dashboard_altair/readme/USAGE.rst new file mode 100644 index 000000000..495eab4ee --- /dev/null +++ b/kpi_dashboard_altair/readme/USAGE.rst @@ -0,0 +1,2 @@ + +.. figure:: ../static/description/graph.png diff --git a/kpi_dashboard_altair/static/description/config.png b/kpi_dashboard_altair/static/description/config.png new file mode 100644 index 000000000..610d3a698 Binary files /dev/null and b/kpi_dashboard_altair/static/description/config.png differ diff --git a/kpi_dashboard_altair/static/description/graph.png b/kpi_dashboard_altair/static/description/graph.png new file mode 100644 index 000000000..09c78653b Binary files /dev/null and b/kpi_dashboard_altair/static/description/graph.png differ diff --git a/kpi_dashboard_altair/static/description/index.html b/kpi_dashboard_altair/static/description/index.html index 870ddd41e..0369fd2b9 100644 --- a/kpi_dashboard_altair/static/description/index.html +++ b/kpi_dashboard_altair/static/description/index.html @@ -376,11 +376,12 @@ ul.auto-toc {
  • Configure KPIs
  • -
  • Bug Tracker
  • -
  • Credits @@ -414,10 +415,17 @@ class Kpi(models.Model):

    You can use code in a similar way, as pandas and altair are already defined when using code on an altair widget.

    +https://raw.githubusercontent.com/akretion/reporting-engine/12.0/kpi_dashboard_altair/static/description/config.png + + +
    +

    Usage

    +
    +https://raw.githubusercontent.com/akretion/reporting-engine/12.0/kpi_dashboard_altair/static/description/graph.png
    -

    Bug Tracker

    +

    Bug Tracker

    Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed @@ -425,21 +433,21 @@ If you spotted it first, help us smashing it by providing a detailed and welcome

    Do not contact contributors directly about support or help with technical issues.

    -

    Credits

    +

    Credits

    -

    Authors

    +

    Authors

    • Creu Blanca
    -

    Maintainers

    +

    Maintainers

    This module is maintained by the OCA.

    Odoo Community Association

    OCA, or the Odoo Community Association, is a nonprofit organization whose