diff --git a/doc/source/conf.py b/doc/source/conf.py index 08f437453b5fbfae9b8301c6e5cd68cf98600156..da8a1e84bb7b4f75a050259a253446be697a907d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -49,7 +49,7 @@ master_doc = 'index' # General information about the project. project = u'm-unit-tests' -copyright = u'2014, Stéphane Adjemian' +copyright = u'2014-2018, DynareTeam' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/doc/source/index.rst b/doc/source/index.rst index af4cefbcef6ebec82c862e2b1426cdecdef2ba8a..8035223e302b36a6662a408c1cfca27a593dec54 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -107,9 +107,9 @@ Contents: **INPUTS** - ``dirname`` (*string*) Path to the directory. - - ``savereport`` (*integer*) Scalar equal to ``0`` or ``1``. If equal to ``1`` generated report is saved in a ``*.mat`` file. - - ``printreport`` (*integer*) Scalar equal to ``0`` or ``1``. If equal to ``1`` generated report is printed on screen. - - ``sendreport`` (*integer*) Scalar equal to ``0`` or ``1``. If equal to ``1`` generated report is sent by email. + - ``savereport`` (*logical*) Scalar equal to ``false`` or ``true``. If equal to ``true`` generated report is saved in a ``*.mat`` file. + - ``printreport`` (*logical*) Scalar equal to ``false`` or ``true``. If equal to ``true`` generated report is printed on screen. + - ``sendreport`` (*string*) Email adress. If not empty generated report is sent by email. **OUTPUTS** - ``report`` (*cell*) First output argument of :func:`run_unitary_test routine`. @@ -118,6 +118,14 @@ Contents: 1. Git needs to be available on the system, and it is assumed that the content of ``dirname`` is versionned with Git. +.. function:: display_report(report) + + Displays detailed report for the testsuite. + + **INPUTS** + - ``report`` (*cell*) Output of :func:`run_unitary_tests_in_directory`. + + Indices and tables ==================