Techsystech
/
OCA_Reporting_engine_17.0
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

IMP kpi_dashb_altair: doc

pull/399/head
David Beal 2020-05-09 15:36:51 +02:00
parent 6b9a371513
commit 5a663f3807
7 changed files with 38 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
kpi_dashboard_altair/README.rst
View File

@ -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 You can use `code` in a similar way, as `pandas` and `altair` are already defined
when using `code` on an `altair` widget. 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 Bug Tracker
=========== ===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20kpi_dashboard_altair%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20kpi_dashboard_altair%0Aversion:%2012-altair-readme%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues. Do not contact contributors directly about support or help with technical issues.

5
kpi_dashboard_altair/__manifest__.py
View File

@ -5,7 +5,7 @@
"name": "Kpi Dashboard Altair", "name": "Kpi Dashboard Altair",
"summary": """ "summary": """
Create dashboards using altair""", Create dashboards using altair""",
"version": "12.0.1.0.1", "version": "12.0.1.0.2",
"license": "AGPL-3", "license": "AGPL-3",
"author": "Creu Blanca,Odoo Community Association (OCA)", "author": "Creu Blanca,Odoo Community Association (OCA)",
"website": "https://github.com/OCA/reporting-engine", "website": "https://github.com/OCA/reporting-engine",
@ -13,8 +13,9 @@
"data": ["views/webclient_templates.xml"], "data": ["views/webclient_templates.xml"],
"qweb": ["static/src/xml/dashboard.xml"], "qweb": ["static/src/xml/dashboard.xml"],
"external_dependencies": { "external_dependencies": {
"python": ['altair'], "python": ["altair"],
}, },
"demo": ["demo/demo_dashboard_altair.xml"], "demo": ["demo/demo_dashboard_altair.xml"],
"maintainers": ["etobella"], "maintainers": ["etobella"],
} }

4
kpi_dashboard_altair/readme/CONFIGURE.rst
View File

@ -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 You can use `code` in a similar way, as `pandas` and `altair` are already defined
when using `code` on an `altair` widget. when using `code` on an `altair` widget.
.. image:: ../static/description/config.png

2
kpi_dashboard_altair/readme/USAGE.rst 100644
View File

@ -0,0 +1,2 @@
.. figure:: ../static/description/graph.png

BIN
kpi_dashboard_altair/static/description/config.png 100644
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 86 KiB

BIN
kpi_dashboard_altair/static/description/graph.png 100644
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 116 KiB

28
kpi_dashboard_altair/static/description/index.html
View File

@ -376,11 +376,12 @@ ul.auto-toc {
<li><a class="reference internal" href="#configure-kpis" id="id2">Configure KPIs</a></li> <li><a class="reference internal" href="#configure-kpis" id="id2">Configure KPIs</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li> <li><a class="reference internal" href="#usage" id="id3">Usage</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul> <li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li> <li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li> <li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li> <li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -414,10 +415,17 @@ class Kpi(models.Model):
</pre> </pre>
<p>You can use <cite>code</cite> in a similar way, as <cite>pandas</cite> and <cite>altair</cite> are already defined <p>You can use <cite>code</cite> in a similar way, as <cite>pandas</cite> and <cite>altair</cite> are already defined
when using <cite>code</cite> on an <cite>altair</cite> widget.</p> when using <cite>code</cite> on an <cite>altair</cite> widget.</p>
<img alt="https://raw.githubusercontent.com/akretion/reporting-engine/12.0/kpi_dashboard_altair/static/description/config.png" src="https://raw.githubusercontent.com/akretion/reporting-engine/12.0/kpi_dashboard_altair/static/description/config.png" />
</div>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id3">Usage</a></h1>
<div class="figure">
<img alt="https://raw.githubusercontent.com/akretion/reporting-engine/12.0/kpi_dashboard_altair/static/description/graph.png" src="https://raw.githubusercontent.com/akretion/reporting-engine/12.0/kpi_dashboard_altair/static/description/graph.png" />
</div> </div>
</div> </div>
<div class="section" id="bug-tracker"> <div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1> <h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported. 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 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
<p>Do not contact contributors directly about support or help with technical issues.</p> <p>Do not contact contributors directly about support or help with technical issues.</p>
</div> </div>
<div class="section" id="credits"> <div class="section" id="credits">
<h1><a class="toc-backref" href="#id4">Credits</a></h1> <h1><a class="toc-backref" href="#id5">Credits</a></h1>
<div class="section" id="authors"> <div class="section" id="authors">
<h2><a class="toc-backref" href="#id5">Authors</a></h2> <h2><a class="toc-backref" href="#id6">Authors</a></h2>
<ul class="simple"> <ul class="simple">
<li>Creu Blanca</li> <li>Creu Blanca</li>
</ul> </ul>
</div> </div>
<div class="section" id="contributors"> <div class="section" id="contributors">
<h2><a class="toc-backref" href="#id6">Contributors</a></h2> <h2><a class="toc-backref" href="#id7">Contributors</a></h2>
<ul class="simple"> <ul class="simple">
<li>Enric Tobella &lt;<a class="reference external" href="mailto:etobella&#64;creublanca.es">etobella&#64;creublanca.es</a>&gt;</li> <li>Enric Tobella &lt;<a class="reference external" href="mailto:etobella&#64;creublanca.es">etobella&#64;creublanca.es</a>&gt;</li>
</ul> </ul>
</div> </div>
<div class="section" id="maintainers"> <div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id7">Maintainers</a></h2> <h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p> <p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose <p>OCA, or the Odoo Community Association, is a nonprofit organization whose