Use the README generator.

Author: sbidoul

docs/changes.rst

@@ -0,0 +1,12 @@
+History
+=======
+
+mis_builder
+-----------
+
+.. include:: ../mis_builder/HISTORY.rst
+
+mis_builder_budget
+------------------
+
+.. include:: ../mis_builder_budget/HISTORY.rst

docs/history.rst

@@ -14,7 +14,7 @@ beautiful, custom reports such as P&L, Balance Sheets and more.
    :caption: Contents:
 
    intro
-   changes
+   history
 
 Indices and tables
 ==================

docs/index.rst

@@ -1,17 +1,36 @@
-.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
-    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
-    :alt: License: AGPL-3
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 ===========
 MIS Builder
 ===========
 
+.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Production/Stable
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fmis--builder-lightgray.png?logo=github
+    :target: https://github.com/OCA/mis-builder/tree/10.0/mis_builder
+    :alt: OCA/mis-builder
+.. |badge4| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/248/10.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| 
+
 This module allows you to build Management Information Systems dashboards.
 Such style of reports presents KPI in rows and time periods in columns.
 Reports mainly fetch data from account moves, but can also combine data coming
 from arbitrary Odoo models. Reports can be exported to PDF, Excel and they
 can be added to Odoo dashboards.
 
+.. contents::
+   :local:
+
 Installation
 ============
 
@@ -23,8 +42,8 @@ An easy way to install it with all its dependencies is using pip:
 * then restart Odoo, update the addons list in your database, and install
   the MIS Builder application.
 
-Configuration and Usage
-=======================
+Usage
+=====
 
 To configure this module, you need to:
 
@@ -34,31 +53,27 @@ To configure this module, you need to:
 
 .. figure:: https://raw.githubusercontent.com/OCA/mis-builder/10.0/mis_builder/static/description/ex_report_template.png
    :alt: Sample report template
-   :width: 95 %
+   :width: 80 %
    :align: center
 
 * Then in Accounting > Reports > MIS Reporting > MIS Reports you can create report instance by
   binding the templates to time periods, hence defining the columns of your reports.
 
 .. figure:: https://raw.githubusercontent.com/OCA/mis-builder/10.0/mis_builder/static/description/ex_report_settings.png
    :alt: Sample report configuration
-   :width: 95 %
+   :width: 80 %
    :align: center
 
 * From the MIS Reports view, you can preview the report, add it to and Odoo dashboard,
   and export it to PDF or Excel.
 
 .. figure:: https://raw.githubusercontent.com/OCA/mis-builder/10.0/mis_builder/static/description/ex_report_preview.png
    :alt: Sample preview
-   :width: 95 %
+   :width: 80 %
    :align: center
 
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
-   :alt: Try me on Runbot
-   :target: https://runbot.odoo-community.org/runbot/248/10.0
-
-Developer notes
-===============
+Development
+===========
 
 A typical extension is to provide a mechanism to filter reports on analytic dimensions
 or operational units. To implement this, you can override _get_additional_move_line_filter
@@ -72,7 +87,224 @@ Known issues / Roadmap
 
 The mis_builder `roadmap <https://github.com/OCA/mis-builder/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement>`_ 
 and `known issues <https://github.com/OCA/mis-builder/issues?q=is%3Aopen+is%3Aissue+label%3Abug>`_ can 
-be found on github.
+be found on GitHub.
+
+Changelog
+=========
+
+10.0.3.2.0 (2018-05-02)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* [FIX] make subkpi ordering deterministic
+  (`#71 <https://github.com/OCA/mis-builder/issues/71>`_)
+* [ADD] report instance level option to disable account expansion,
+  enabling the creation of detailed templates while deferring the decision
+  of rendering the details or not to the report instance
+  (`#74 <https://github.com/OCA/mis-builder/issues/74>`_)
+* [ADD] pbal and nbal accounting expressions, to sum positive
+  and negative balances respectively (ie ignoring accounts with negative,
+  resp positive balances)
+  (`#86 <https://github.com/OCA/mis-builder/issues/86>`_)
+
+10.0.3.1.1 (2017-11-14)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+New features:
+
+* [ADD] month and year relative periods, easier to use than
+  date ranges for the most common case.
+  (`#2 <https://github.com/OCA/mis-builder/issues/2>`_)
+* [ADD] multi-company consolidation support, with currency conversion
+  (the conversion rate date is the end of the reporting period)
+  (`#7 <https://github.com/OCA/mis-builder/issues/7>`_, 
+  `#3 <https://github.com/OCA/mis-builder/issues/3>`_)
+* [ADD] provide ref, datetime, dateutil, time, user in the evaluation 
+  context of move line domains; among other things, this allows using 
+  references to xml ids (such as account types or tax tags) when 
+  querying move lines 
+  (`#26 <https://github.com/OCA/mis-builder/issues/26>`_).
+* [ADD] extended account selectors: you can now select accounts using
+  any domain on account.account, not only account codes
+  ``balp[('user_type_id', '=', ref('account.data_account_type_receivable').id)]``
+  (`#4 <https://github.com/OCA/mis-builder/issues/4>`_).
+* [IMP] in the report instance configuration form, the filters are
+  now grouped in a notebook page, this improves readability and
+  extensibility
+  (`#39 <https://github.com/OCA/mis-builder/issues/39>`_).
+
+Bug fixes:
+
+* [FIX] fix error when saving periods in comparison mode on newly 
+  created (not yet saved) report instances.
+  `#50 <https://github.com/OCA/mis-builder/pull/50>`_
+* [FIX] improve display of Base Date report instance view.
+  `#51 <https://github.com/OCA/mis-builder/pull/51>`_
+
+Upgrading from 3.0 (breaking changes):
+
+* Alternative move line data sources must have a company_id field.
+
+10.0.3.0.4 (2017-10-14)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Bug fix:
+
+* [FIX] issue with initial balance rounding.
+  `#30 <https://github.com/OCA/mis-builder/issues/30>`_
+
+10.0.3.0.3 (2017-10-03)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Bug fix:
+
+* [FIX] fix error saving KPI on newly created reports.
+  `#18 <https://github.com/OCA/mis-builder/issues/18>`_
+
+10.0.3.0.2 (2017-10-01)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+New features:
+
+* [ADD] Alternative move line source per report column.
+  This makes mis buidler accounting expressions work on any model
+  that has debit, credit, account_id and date fields. Provided you can
+  expose, say, committed purchases, or your budget as a view with
+  debit, credit and account_id, this opens up a lot of possibilities
+* [ADD] Comparison column source (more flexible than the previous,
+  now deprecated, comparison mechanism).
+  CAVEAT: there is no automated migration to the new mechanism.
+* [ADD] Sum column source, to create columns that add/subtract
+  other columns.
+* [ADD] mis.kpi.data abstract model as a basis for manual KPI values
+  supporting automatic ajustment to the reporting time period (the basis
+  for budget item, but could also server other purposes, such as manually
+  entering some KPI values, such as number of employee)
+* [ADD] mis_builder_budget module providing a new budget data source
+* [ADD] new "hide empty" style property
+* [IMP] new AEP method to get accounts involved in an expression
+  (this is useful to find which KPI relate to a given P&L
+  acount, to implement budget control)
+* [IMP] many UI improvements
+* [IMP] many code style improvements and some refactoring
+* [IMP] add the column date_from, date_to in expression evaluation context,
+  as well as time, datetime and dateutil modules
+
+Main bug fixes:
+
+* [FIX] deletion of templates and reports (cascade and retricts) 
+  (https://github.com/OCA/account-financial-reporting/issues/281)
+* [FIX] copy of reports 
+  (https://github.com/OCA/account-financial-reporting/issues/282)
+* [FIX] better error message when periods have wrong/missing dates 
+  (https://github.com/OCA/account-financial-reporting/issues/283)
+* [FIX] xlsx export of string types KPI 
+  (https://github.com/OCA/account-financial-reporting/issues/285)
+* [FIX] sorting of detail by account
+* [FIX] computation bug in detail by account when multiple accounting
+  expressions were used in a KPI
+* [FIX] permission issue when adding report to dashboard with non admin user
+
+10.0.2.0.3 (unreleased)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* [IMP] more robust behaviour in presence of missing expressions
+* [FIX] indent style
+* [FIX] local variable 'ctx' referenced before assignment when generating
+  reports with no objects
+* [IMP] use fontawesome icons
+* [MIG] migrate to 10.0
+* [FIX] unicode error when exporting to Excel
+* [IMP] provide full access to mis builder style for group Adviser.
+
+9.0.2.0.2 (2016-09-27)
+~~~~~~~~~~~~~~~~~~~~~~
+
+* [IMP] Add refresh button in mis report preview.
+* [IMP] Widget code changes to allow to add fields in the widget more easily.
+
+9.0.2.0.1 (2016-05-26)
+~~~~~~~~~~~~~~~~~~~~~~
+
+* [IMP] remove unused argument in declare_and_compute_period()
+  for a cleaner API. This is a breaking API changing merged in
+  urgency before it is used by other modules.
+
+9.0.2.0.0 (2016-05-24)
+~~~~~~~~~~~~~~~~~~~~~~
+
+Part of the work for this release has been done at the Sorrento sprint
+April 26-29, 2016. The rest (ie a major refactoring) has been done in
+the weeks after.
+
+* [IMP] hide button box in edit mode on the report instance settings form
+* [FIX] Fix sum aggregation of non-stored fields 
+  (https://github.com/OCA/account-financial-reporting/issues/178)
+* [IMP] There is now a default style at the report level
+* [CHG] Number display properties (rounding, prefix, suffix, factor) are
+  now defined in styles
+* [CHG] Percentage difference are rounded to 1 digit instead of the kpi's
+  rounding, as the KPI rounding does not make sense in this case
+* [CHG] The divider suffix (k, M, etc) is not inserted automatically anymore
+  because it is inconsistent when working with prefixes; you need to add it
+  manually in the suffix
+* [IMP] AccountingExpressionProcessor now supports 'balu' expressions
+  to obtain the unallocated profit/loss of previous fiscal years;
+  get_unallocated_pl is the corresponding convenience method
+* [IMP] AccountingExpressionProcessor now has easy methods to obtain
+  balances by account: get_balances_initial, get_balances_end,
+  get_balances_variation
+* [IMP] there is now an auto-expand feature to automatically display
+  a detail by account for selected kpis
+* [IMP] the kpi and period lists are now manipulated through forms instead
+  of directly in the tree views
+* [IMP] it is now possible to create a report through a wizard, such
+  reports are deemed temporary and available through a "Last Reports Generated"
+  menu, they are garbaged collected automatically, unless saved permanently,
+  which can be done using a Save button
+* [IMP] there is now a beginner mode to configure simple reports with
+  only one period
+* [IMP] it is now easier to configure periods with fixed start/end dates
+* [IMP] the new sub-kpi mechanism allows the creation of columns
+  with multiple values, or columns with different values
+* [IMP] thanks to the new style model, the Excel export is now styled
+* [IMP] a new style model is now used to centralize style configuration
+* [FIX] use =like instead of like to search for accounts, because
+  the % are added by the user in the expressions
+* [FIX] Correctly compute the initial balance of income and expense account
+  based on the start of the fiscal year
+* [IMP] Support date ranges (from OCA/server-tools/date_range) as a more
+  flexible alternative to fiscal periods
+* v9 migration: fiscal periods are removed, account charts are removed,
+  consolidation accounts have been removed
+
+8.0.1.0.0 (2016-04-27)
+~~~~~~~~~~~~~~~~~~~~~~
+
+* The copy of a MIS Report Instance now copies period.
+  https://github.com/OCA/account-financial-reporting/pull/181
+* The copy of a MIS Report Template now copies KPIs and queries.
+  https://github.com/OCA/account-financial-reporting/pull/177
+* Usability: the default view for MIS Report instances is now the rendered preview,
+  and the settings are accessible through a gear icon in the list view and
+  a button in the preview.
+  https://github.com/OCA/account-financial-reporting/pull/170
+* Display blank cells instead of 0.0 when there is no data.
+  https://github.com/OCA/account-financial-reporting/pull/169
+* Usability: better layout of the MIS Report periods settings on small screens.
+  https://github.com/OCA/account-financial-reporting/pull/167
+* Include the download buttons inside the MIS Builder widget, and refactor
+  the widget to open the door to analytic filtering in the previews.
+  https://github.com/OCA/account-financial-reporting/pull/151
+* Add KPI rendering prefixes (so you can print $ in front of the value).
+  https://github.com/OCA/account-financial-reporting/pull/158
+* Add hooks for analytic filtering.
+  https://github.com/OCA/account-financial-reporting/pull/128
+  https://github.com/OCA/account-financial-reporting/pull/131
+
+8.0.0.2.0
+~~~~~~~~~
+
+Pre-history. Or rather, you need to look at the git log.
 
 Bug Tracker
 ===========
@@ -81,17 +313,20 @@ Bugs are tracked on `GitHub Issues <https://github.com/OCA/mis-builder/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.
 
+Do not contact contributors directly about support or help with technical issues.
+
 Credits
 =======
 
-Author
-------
+Authors
+~~~~~~~
 
-* Stéphane Bidoul <[email protected]>
+* ACSONE SA/NV
 
 Contributors
-------------
+~~~~~~~~~~~~
 
+* Stéphane Bidoul <[email protected]>
 * Laetitia Gangloff <[email protected]>
 * Adrien Peiffer <[email protected]>
 * Alexis de Lattre <[email protected]>
@@ -109,17 +344,27 @@ Contributors
 * Juan Jose Scarafia <[email protected]>
 * Richard deMeester <[email protected]>
 
-Maintainer
-----------
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
 
 .. image:: https://odoo-community.org/logo.png
    :alt: Odoo Community Association
    :target: https://odoo-community.org
 
-This module is maintained by the OCA.
-
 OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.
 
-To contribute to this module, please visit https://odoo-community.org.
+.. |maintainer-sbidoul| image:: https://github.com/sbidoul.png?size=40px
+    :target: https://github.com/sbidoul
+    :alt: sbidoul
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`_:
+
+|maintainer-sbidoul| 
+
+This module is part of the `OCA/mis-builder <https://github.com/OCA/mis-builder/tree/10.0/mis_builder>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.