.. _report_module:

Report module
=================


.. warning::
  This section is Work in progress. Report in demcompare is not finalized.




- **demcompare.report** modules in `report file <https://github.com/CNES/demcompare/blob/master/demcompare/report.py>`_

Module in charge of generating output demcompare's report to visualize the results (graphs, stats, ...)

- **sphinx_project_generator** module in `sphinx_project_generator file <https://github.com/CNES/demcompare/blob/master/demcompare/sphinx_project_generator.py>`_

sphinx_project_generator is a module containing the helper functions for the creation of the output demcompare's report
and ease its manipulation.